invenio-app-ils 1.0.0a54__py2.py3-none-any.whl → 6.1.0__py2.py3-none-any.whl

invenio_app_ils/circulation/api.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2018-2020 CERN.
+# Copyright (C) 2018-2025 CERN.
 #
 # invenio-app-ils is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -12,7 +12,6 @@ from copy import copy, deepcopy
 from datetime import date, timedelta
 from functools import partial
 
-from elasticsearch import VERSION as ES_VERSION
 from flask import current_app
 from flask_login import current_user
 from invenio_circulation.config import (
@@ -27,14 +26,22 @@ from invenio_db import db
 from invenio_pidstore.models import PIDStatus
 from invenio_pidstore.providers.recordid_v2 import RecordIdProviderV2
 
+from invenio_app_ils.circulation.notifications.api import (
+    send_dates_updated_notification,
+)
 from invenio_app_ils.circulation.search import (
-    get_all_range_expiring_ils_loans_by_patron_pid,
+    get_all_expiring_or_overdue_loans_by_patron_pid,
 )
 from invenio_app_ils.errors import (
+    DocumentOverbookedError,
     IlsException,
     InvalidLoanExtendError,
     InvalidParameterError,
+    ItemCannotCirculateError,
+    ItemHasActiveLoanError,
+    ItemNotFoundError,
     MissingRequiredParameterError,
+    MultipleItemsBarcodeFoundError,
     PatronHasLoanOnDocumentError,
     PatronHasLoanOnItemError,
     PatronHasRequestOnDocumentError,
@@ -44,9 +51,6 @@ from invenio_app_ils.items.api import Item
 from invenio_app_ils.minters import pid_minter
 from invenio_app_ils.proxies import current_app_ils
 
-lt_es7 = ES_VERSION[0] < 7
-
-
 # override default `invenio-circulation` minters to use the base32 PIDs
 # CIRCULATION_LOAN_PID_TYPE is already defined in `invenio-circulation`
 ILS_CIRCULATION_LOAN_MINTER = "ilsloanid"
@@ -55,9 +59,7 @@ ILS_CIRCULATION_LOAN_FETCHER = "ilsloanid"
 IlsCirculationLoanIdProvider = type(
     "IlsCirculationLoanIdProvider",
     (RecordIdProviderV2,),
-    dict(
-        pid_type=CIRCULATION_LOAN_PID_TYPE, default_status=PIDStatus.REGISTERED
-    ),
+    dict(pid_type=CIRCULATION_LOAN_PID_TYPE, default_status=PIDStatus.REGISTERED),
 )
 ils_circulation_loan_pid_minter = partial(
     pid_minter, provider_cls=IlsCirculationLoanIdProvider
@@ -79,9 +81,9 @@ def _validate_delivery(delivery):
             )
 
 
-def _set_item_to_can_circulate(item_pid):
+def _set_item_to_can_circulate(item_pid_value):
     """Change the item status to CAN_CIRCULATE."""
-    item = Item.get_record_by_pid(item_pid["value"])
+    item = Item.get_record_by_pid(item_pid_value)
     if item["status"] != "CAN_CIRCULATE":
         item["status"] = "CAN_CIRCULATE"
         item.commit()
@@ -91,16 +93,12 @@ def _set_item_to_can_circulate(item_pid):
 
 def patron_has_request_on_document(patron_pid, document_pid):
     """Return loan request for given patron and document."""
-    states = (
-            current_app.config["CIRCULATION_STATES_LOAN_REQUEST"]
-        )
+    states = current_app.config["CIRCULATION_STATES_LOAN_REQUEST"]
     search = search_by_patron_item_or_document(
         patron_pid=patron_pid, document_pid=document_pid, filter_states=states
     )
     search_result = search.execute()
-    total = (
-        search_result.hits.total if lt_es7 else search_result.hits.total.value
-    )
+    total = search_result.hits.total.value
     if total > 0:
         return search_result.hits[0]
     else:
@@ -117,9 +115,7 @@ def patron_has_active_loan_or_request_on_document(patron_pid, document_pid):
         patron_pid=patron_pid, document_pid=document_pid, filter_states=states
     )
     search_result = search.execute()
-    total = (
-        search_result.hits.total if lt_es7 else search_result.hits.total.value
-    )
+    total = search_result.hits.total.value
     if total > 0:
         return search_result.hits[0]
     else:
@@ -131,7 +127,7 @@ def request_loan(
     patron_pid,
     transaction_location_pid,
     transaction_user_pid=None,
-    **kwargs
+    **kwargs,
 ):
     """Create a new loan and trigger the first transition to PENDING."""
     loan_cls = current_circulation.loan_record_cls
@@ -179,11 +175,48 @@ def patron_has_active_loan_on_item(patron_pid, item_pid):
         filter_states=current_app.config["CIRCULATION_STATES_LOAN_ACTIVE"],
     )
     search_result = search.execute()
-    return (
-        search_result.hits.total > 0
-        if lt_es7
-        else search_result.hits.total.value > 0
+    return search_result.hits.total.value > 0
+
+
+def _checkout_loan(
+    item_pid,
+    patron_pid,
+    transaction_location_pid,
+    trigger="checkout",
+    transaction_user_pid=None,
+    delivery=None,
+    **kwargs,
+):
+    """Checkout a loan."""
+    transaction_user_pid = transaction_user_pid or str(current_user.id)
+    loan_cls = current_circulation.loan_record_cls
+    # create a new loan
+    record_uuid = uuid.uuid4()
+    new_loan = dict(
+        patron_pid=patron_pid,
+        transaction_location_pid=transaction_location_pid,
+        transaction_user_pid=transaction_user_pid,
+    )
+
+    if delivery:
+        new_loan["delivery"] = delivery
+    # check if there is an existing request
+    loan = patron_has_request_on_document(patron_pid, kwargs.get("document_pid"))
+    if loan:
+        loan = loan_cls.get_record_by_pid(loan.pid)
+        pid = IlsCirculationLoanIdProvider.get(loan["pid"]).pid
+        loan.update(new_loan)
+    else:
+        pid = ils_circulation_loan_pid_minter(record_uuid, data=new_loan)
+        loan = loan_cls.create(data=new_loan, id_=record_uuid)
+
+    params = deepcopy(loan)
+    params.update(item_pid=item_pid, **kwargs)
+
+    loan = current_circulation.circulation.trigger(
+        loan, **dict(params, trigger=trigger)
     )
+    return pid, loan
 
 
 def checkout_loan(
@@ -192,7 +225,7 @@ def checkout_loan(
     transaction_location_pid,
     transaction_user_pid=None,
     force=False,
-    **kwargs
+    **kwargs,
 ):
     """Create a new loan and trigger the first transition to ITEM_ON_LOAN.
 
@@ -207,61 +240,114 @@ def checkout_loan(
         the checkout. If False, the checkout will fail when the item cannot
         circulate.
     """
-    loan_cls = current_circulation.loan_record_cls
-    if patron_has_active_loan_on_item(
-        patron_pid=patron_pid, item_pid=item_pid
-    ):
+
+    if patron_has_active_loan_on_item(patron_pid=patron_pid, item_pid=item_pid):
         raise PatronHasLoanOnItemError(patron_pid, item_pid)
     optional_delivery = kwargs.get("delivery")
     if optional_delivery:
         _validate_delivery(optional_delivery)
 
     if force:
-        _set_item_to_can_circulate(item_pid)
+        _set_item_to_can_circulate(item_pid["value"])
 
-    transaction_user_pid = transaction_user_pid or str(current_user.id)
-
-    # create a new loan
-    record_uuid = uuid.uuid4()
-    new_loan = dict(
-        patron_pid=patron_pid,
-        transaction_location_pid=transaction_location_pid,
+    return _checkout_loan(
+        item_pid,
+        patron_pid,
+        transaction_location_pid,
         transaction_user_pid=transaction_user_pid,
+        **kwargs,
     )
 
-    # check if there is an existing request
-    loan = patron_has_request_on_document(
-        patron_pid, kwargs.get("document_pid")
-    )
-    if loan:
-        loan = loan_cls.get_record_by_pid(loan.pid)
-        pid = IlsCirculationLoanIdProvider.get(loan["pid"]).pid
-        loan.update(new_loan)
-    else:
-        pid = ils_circulation_loan_pid_minter(record_uuid, data=new_loan)
-        loan = loan_cls.create(data=new_loan, id_=record_uuid)
 
-    params = deepcopy(loan)
-    params.update(item_pid=item_pid, **kwargs)
+def _ensure_item_loanable_via_self_checkout(item_pid_value):
+    """Self-checkout: return loanable item or raise when not loanable.
 
-    # trigger the transition to request
-    loan = current_circulation.circulation.trigger(
-        loan, **dict(params, trigger="checkout")
+    Implements the self-checkout rules to loan an item.
+    """
+    item = current_app_ils.item_record_cls.get_record_by_pid(item_pid_value)
+    item_dict = item.replace_refs()
+
+    if item_dict["status"] == "MISSING":
+        _set_item_to_can_circulate(item_pid_value)
+        item = current_app_ils.item_record_cls.get_record_by_pid(item_pid_value)
+        item_dict = item.replace_refs()
+
+    if item_dict["status"] != "CAN_CIRCULATE":
+        raise ItemCannotCirculateError()
+
+    circulation_state = item_dict["circulation"].get("state")
+    has_active_loan = (
+        circulation_state and circulation_state in CIRCULATION_STATES_LOAN_ACTIVE
     )
+    if has_active_loan:
+        raise ItemHasActiveLoanError(loan_pid=item_dict["circulation"]["loan_pid"])
+
+    document = current_app_ils.document_record_cls.get_record_by_pid(
+        item_dict["document_pid"]
+    )
+    document_dict = document.replace_refs()
+    if document_dict["circulation"].get("overbooked", False):
+        raise DocumentOverbookedError(
+            f"Cannot self-checkout the overbooked document {item_dict['document_pid']}"
+        )
+
+    return item
 
-    return pid, loan
+
+def self_checkout_get_item_by_barcode(barcode):
+    """Search for an item by barcode.
+
+    :param barcode: the barcode of the item to search for
+    :return item: the item that was found, or raise in case of errors
+    """
+    item_search = current_app_ils.item_search_cls()
+    items = item_search.search_by_barcode(barcode).execute()
+    if items.hits.total.value == 0:
+        raise ItemNotFoundError(barcode=barcode)
+    if items.hits.total.value > 1:
+        raise MultipleItemsBarcodeFoundError(barcode)
+
+    item_pid = items.hits[0].pid
+    item = _ensure_item_loanable_via_self_checkout(item_pid)
+    return item_pid, item
+
+
+def self_checkout(
+    item_pid, patron_pid, transaction_location_pid, transaction_user_pid=None, **kwargs
+):
+    """Perform self-checkout.
+
+    :param item_pid: a dict containing `value` and `type` fields to
+        uniquely identify the item.
+    :param patron_pid: the PID value of the patron
+    :param transaction_location_pid: the PID value of the location where the
+        checkout is performed
+    :param transaction_user_pid: the PID value of the user that performed the
+        checkout
+    """
+    _ensure_item_loanable_via_self_checkout(item_pid["value"])
+    return _checkout_loan(
+        item_pid,
+        patron_pid,
+        transaction_location_pid,
+        transaction_user_pid=transaction_user_pid,
+        trigger="self_checkout",
+        delivery=dict(method="SELF-CHECKOUT"),
+        **kwargs,
+    )
 
 
 def bulk_extend_loans(patron_pid, **kwargs):
     """Bulk extend qualified loans."""
     loan_class = current_circulation.loan_record_cls
-    days = current_app.config["ILS_CIRCULATION_LOAN_WILL_EXPIRE_DAYS"]
 
-    loans_search = get_all_range_expiring_ils_loans_by_patron_pid(
-        expiring_in_days=days, patron_pid=patron_pid)
+    loans_search = get_all_expiring_or_overdue_loans_by_patron_pid(
+        patron_pid=patron_pid
+    )
 
     extended_loans = []
     not_extended_loans = []
+
     for loan in loans_search.scan():
         loan_record = loan_class.get_record_by_pid(loan["pid"])
         params = deepcopy(loan_record)
@@ -271,8 +357,8 @@ def bulk_extend_loans(patron_pid, **kwargs):
                 **dict(
                     params,
                     trigger="extend",
-                    transition_kwargs=dict(send_notification=False)
-                )
+                    transition_kwargs=dict(send_notification=False),
+                ),
             )
             extended_loans.append(extended_loan)
         except (CirculationException, InvalidLoanExtendError):
@@ -292,14 +378,12 @@ def update_dates_loan(
 ):
     """Updates the dates of a loan."""
     state = record["state"]
-    is_active_or_completed = (
-        state in CIRCULATION_STATES_LOAN_ACTIVE
-        or state in CIRCULATION_STATES_LOAN_COMPLETED
-    )
+    is_active = state in CIRCULATION_STATES_LOAN_ACTIVE
+    is_completed = state in CIRCULATION_STATES_LOAN_COMPLETED
 
     data = copy(record)
 
-    if is_active_or_completed:
+    if is_active or is_completed:
         today = date.today().strftime("%Y-%m-%d")
         if request_start_date or request_expire_date:
             raise IlsException(
@@ -320,8 +404,7 @@ def update_dates_loan(
     else:  # Pending or cancelled
         if start_date or end_date:
             raise IlsException(
-                description="Cannot modify dates of "
-                "a pending or cancelled loan."
+                description="Cannot modify dates of " "a pending or cancelled loan."
             )
         if request_start_date:
             data["request_start_date"] = request_start_date
@@ -335,6 +418,9 @@ def update_dates_loan(
     db.session.commit()
     current_circulation.loan_indexer().index(record)
 
+    if is_active:
+        send_dates_updated_notification(record)
+
     return record
 
 

invenio_app_ils/circulation/config.py

@@ -41,7 +41,7 @@ from invenio_app_ils.items.api import (
 )
 from invenio_app_ils.patrons.api import patron_exists
 from invenio_app_ils.permissions import (
-    PatronOwnerPermission,
+    PatronOwnerReadPermission,
     authenticated_user_permission,
     backoffice_permission,
     loan_extend_circulation_permission,
@@ -51,11 +51,7 @@ from invenio_app_ils.permissions import (
 
 from .api import ILS_CIRCULATION_LOAN_FETCHER, ILS_CIRCULATION_LOAN_MINTER
 from .indexer import LoanIndexer
-from .jsonresolvers.loan import (
-    document_resolver,
-    item_resolver,
-    loan_patron_resolver,
-)
+from .jsonresolvers.loan import document_resolver, item_resolver, loan_patron_resolver
 from .notifications.api import circulation_filter_notifications
 from .transitions.transitions import ILSItemOnLoanToItemOnLoan, ILSToItemOnLoan
 from .utils import (
@@ -78,13 +74,17 @@ from .utils import (
 ILS_CIRCULATION_NOTIFICATION_OVERDUE_REMINDER_INTERVAL = 3
 #: The maximum duration of a loan request
 ILS_CIRCULATION_LOAN_REQUEST_DURATION_DAYS = 60
+#: The minimum number of days after which a loan can start from the date of request
+ILS_CIRCULATION_LOAN_REQUEST_OFFSET = 0
 #: Period of time in days, before loans expire, for notifications etc.
 ILS_CIRCULATION_LOAN_WILL_EXPIRE_DAYS = 7
 #: Optional delivery methods when requesting a new loan. Set to empty object to
 # disable it
 ILS_CIRCULATION_DELIVERY_METHODS = {
+    "NOT-SPECIFIED": "Not specified",
     "PICKUP": "Pick it up at the library desk",
     "DELIVERY": "Have it delivered to my office",
+    "SELF-CHECKOUT": "Self-checkout",
 }
 
 # Notification message creator for loan notifications
@@ -109,9 +109,7 @@ CIRCULATION_DOCUMENT_EXISTS = document_exists
 
 CIRCULATION_ITEM_LOCATION_RETRIEVER = circulation_item_location_retriever
 
-CIRCULATION_TRANSACTION_LOCATION_VALIDATOR = (
-    circulation_transaction_location_validator
-)
+CIRCULATION_TRANSACTION_LOCATION_VALIDATOR = circulation_transaction_location_validator
 
 CIRCULATION_TRANSACTION_USER_VALIDATOR = circulation_transaction_user_validator
 
@@ -134,9 +132,7 @@ CIRCULATION_POLICIES = dict(
 
 CIRCULATION_ITEM_REF_BUILDER = circulation_build_item_ref
 
-CIRCULATION_ITEM_RESOLVING_PATH = (
-    "/api/resolver/circulation/loans/<loan_pid>/item"
-)
+CIRCULATION_ITEM_RESOLVING_PATH = "/api/resolver/circulation/loans/<loan_pid>/item"
 
 CIRCULATION_ITEM_RESOLVER_ENDPOINT = item_resolver
 
@@ -150,9 +146,7 @@ CIRCULATION_DOCUMENT_RESOLVER_ENDPOINT = document_resolver
 
 CIRCULATION_PATRON_REF_BUILDER = circulation_build_patron_ref
 
-CIRCULATION_PATRON_RESOLVING_PATH = (
-    "/api/resolver/circulation/loans/<loan_pid>/patron"
-)
+CIRCULATION_PATRON_RESOLVING_PATH = "/api/resolver/circulation/loans/<loan_pid>/patron"
 
 CIRCULATION_PATRON_RESOLVER_ENDPOINT = loan_patron_resolver
 
@@ -171,6 +165,12 @@ CIRCULATION_LOAN_TRANSITIONS = {
             transition=ILSToItemOnLoan,
             permission_factory=backoffice_permission,
         ),
+        dict(
+            dest="ITEM_ON_LOAN",
+            trigger="self_checkout",
+            transition=ILSToItemOnLoan,
+            permission_factory=authenticated_user_permission,
+        ),
     ],
     "PENDING": [
         dict(
@@ -179,6 +179,12 @@ CIRCULATION_LOAN_TRANSITIONS = {
             transition=ILSToItemOnLoan,
             permission_factory=backoffice_permission,
         ),
+        dict(
+            dest="ITEM_ON_LOAN",
+            trigger="self_checkout",
+            transition=ILSToItemOnLoan,
+            permission_factory=authenticated_user_permission,
+        ),
         dict(
             dest="CANCELLED",
             trigger="cancel",
@@ -225,9 +231,7 @@ ILS_CIRCULATION_RECORDS_REST_ENDPOINTS = dict(
         record_class=Loan,
         indexer_class=LoanIndexer,
         record_loaders={
-            "application/json": (
-                "invenio_circulation.records.loaders:loan_loader"
-            )
+            "application/json": "invenio_circulation.records.loaders:loan_loader"
         },
         record_serializers={
             "application/json": (
@@ -238,19 +242,19 @@ ILS_CIRCULATION_RECORDS_REST_ENDPOINTS = dict(
             "application/json": (
                 "invenio_app_ils.circulation.serializers:json_v1_search"
             ),
-            "text/csv": (
-                "invenio_app_ils.circulation.serializers:csv_v1_search"
-            ),
+            "text/csv": "invenio_app_ils.circulation.serializers:csv_v1_search",
+        },
+        search_serializers_aliases={
+            "csv": "text/csv",
+            "json": "application/json",
         },
         list_route="/circulation/loans/",
-        item_route="/circulation/loans/<{0}:pid_value>".format(
-            _LOANID_CONVERTER
-        ),
+        item_route="/circulation/loans/<{0}:pid_value>".format(_LOANID_CONVERTER),
         default_media_type="application/json",
         links_factory_imp="invenio_circulation.links:loan_links_factory",
         max_result_window=RECORDS_REST_MAX_RESULT_WINDOW,
         error_handlers=dict(),
-        read_permission_factory_imp=PatronOwnerPermission,
+        read_permission_factory_imp=PatronOwnerReadPermission,
         # auth via search_factory
         list_permission_factory_imp=authenticated_user_permission,
         create_permission_factory_imp=superuser_permission,

invenio_app_ils/circulation/indexer.py

@@ -14,6 +14,7 @@ from flask import current_app
 from invenio_circulation.pidstore.pids import CIRCULATION_LOAN_PID_TYPE
 from invenio_circulation.proxies import current_circulation
 from invenio_indexer.api import RecordIndexer
+from invenio_pidstore.errors import PIDDeletedError
 
 from invenio_app_ils.circulation.utils import resolve_item_from_loan
 from invenio_app_ils.documents.api import DOCUMENT_PID_TYPE
@@ -48,20 +49,15 @@ def index_referenced_records(loan):
     loan_class = current_circulation.loan_record_cls
     loan_record = loan_class.get_record_by_pid(loan["pid"])
 
-    referenced.append(
-        dict(pid_type=CIRCULATION_LOAN_PID_TYPE, record=loan_record)
-    )
+    referenced.append(dict(pid_type=CIRCULATION_LOAN_PID_TYPE, record=loan_record))
 
     # add all the other loans, as after indexing this one, they
     # will be affected in search
-    pending_loans = \
-        document.search_loan_references().scan()
+    pending_loans = document.search_loan_references().scan()
 
     for loan_hit in pending_loans:
         pending_loan = loan_class.get_record_by_pid(loan_hit.pid)
-        referenced.append(
-            dict(pid_type=CIRCULATION_LOAN_PID_TYPE, record=pending_loan)
-        )
+        referenced.append(dict(pid_type=CIRCULATION_LOAN_PID_TYPE, record=pending_loan))
 
     # index the loan and referenced records
     indexer.index(indexed, referenced)
@@ -86,19 +82,18 @@ def index_extra_fields_for_loan(loan_dict):
     details.
     """
     document_class = current_app_ils.document_record_cls
-    document_record = document_class.get_record_by_pid(
-        loan_dict.get("document_pid")
-    )
+    try:
+        document_record = document_class.get_record_by_pid(loan_dict["document_pid"])
+    except PIDDeletedError:
+        # Document might have been deleted while reindexing asynchronously.
+        return
+
     document = document_record.replace_refs()
 
-    items_available_for_loan_count = document.get("circulation", {}).get(
-        "available_items_for_loan_count"
-    )
-    loan_dict[
+    items_available_for_loan_count = document["circulation"][
         "available_items_for_loan_count"
-    ] = items_available_for_loan_count
+    ]
+    loan_dict["available_items_for_loan_count"] = items_available_for_loan_count
 
-    can_circulate_items_count = document.get("circulation", {}).get(
-        "can_circulate_items_count"
-    )
+    can_circulate_items_count = document["circulation"]["can_circulate_items_count"]
     loan_dict["can_circulate_items_count"] = can_circulate_items_count

invenio_app_ils/circulation/loaders/__init__.py

@@ -12,9 +12,11 @@ from invenio_app_ils.records.loaders import ils_marshmallow_loader
 from .schemas.json.bulk_extend import BulkExtendLoansSchemaV1
 from .schemas.json.loan_checkout import LoanCheckoutSchemaV1
 from .schemas.json.loan_request import LoanRequestSchemaV1
+from .schemas.json.loan_self_checkout import LoanSelfCheckoutSchemaV1
 from .schemas.json.loan_update_dates import LoanUpdateDatesSchemaV1
 
 loan_request_loader = ils_marshmallow_loader(LoanRequestSchemaV1)
 loan_checkout_loader = ils_marshmallow_loader(LoanCheckoutSchemaV1)
+loan_self_checkout_loader = ils_marshmallow_loader(LoanSelfCheckoutSchemaV1)
 loan_update_dates_loader = ils_marshmallow_loader(LoanUpdateDatesSchemaV1)
 loans_bulk_update_loader = ils_marshmallow_loader(BulkExtendLoansSchemaV1)

invenio_app_ils/circulation/loaders/schemas/json/loan_checkout.py

@@ -26,7 +26,7 @@ class LoanCheckoutSchemaV1(LoanBaseSchemaV1):
     item_pid = fields.Nested(LoanItemPIDSchemaV1, required=True)
     start_date = DateString()
     end_date = DateString()
-    force = fields.Bool(missing=False)
+    force = fields.Bool(load_default=False)
 
     @validates("force")
     def validate_force(self, value, **kwargs):
@@ -57,8 +57,7 @@ class LoanCheckoutSchemaV1(LoanBaseSchemaV1):
                             "The loan start date cannot be after the end date."
                         ],
                         "end_date": [
-                            "The loan end date cannot"
-                            " be before the start date."
+                            "The loan end date cannot" " be before the start date."
                         ],
                     }
                 )