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

invenio_app_ils/circulation/templates/invenio_app_ils_circulation/notifications/update_dates.html

@@ -0,0 +1,19 @@
+{% block title %}
+InvenioILS: loan dates changed for "{{ document.title|safe }}"
+{% endblock %}
+
+{% block body_plain %}
+Dear {{ patron.name }},
+
+The dates of your loan for "{{ document.full_title }}" <{{ spa_routes.HOST }}{{ spa_routes.PATHS['literature']|format(pid=document.pid) }}> have been changed.
+
+The new dates are {{ loan.start_date }} to {{ loan.end_date }}.
+{% endblock %}
+
+{% block body_html %}
+Dear {{ patron.name }}, <br/><br/>
+
+The dates of your loan for <a href="{{ spa_routes.HOST }}{{ spa_routes.PATHS['literature']|format(pid=document.pid) }}">"{{ document.full_title }}"</a> have been <b>changed</b>. <br/>
+
+The new dates are <b>{{ loan.start_date }}</b> to <b>{{ loan.end_date }}</b>.<br/>
+{% endblock %}

invenio_app_ils/circulation/utils.py

@@ -20,11 +20,13 @@ from invenio_app_ils.proxies import current_app_ils
 def circulation_build_item_ref(loan_pid, loan):
     """Build $ref for the Item attached to the Loan."""
     return {
-        "$ref": "{scheme}://{host}/api/resolver/circulation/loans/{loan_pid}/"
-        "item".format(
-            scheme=current_app.config["JSONSCHEMAS_URL_SCHEME"],
-            host=current_app.config["JSONSCHEMAS_HOST"],
-            loan_pid=loan_pid,
+        "$ref": (
+            "{scheme}://{host}/api/resolver/circulation/loans/{loan_pid}/"
+            "item".format(
+                scheme=current_app.config["JSONSCHEMAS_URL_SCHEME"],
+                host=current_app.config["JSONSCHEMAS_HOST"],
+                loan_pid=loan_pid,
+            )
         )
     }
 
@@ -32,11 +34,13 @@ def circulation_build_item_ref(loan_pid, loan):
 def circulation_build_patron_ref(loan_pid, loan):
     """Build $ref for the Patron of the Loan."""
     return {
-        "$ref": "{scheme}://{host}/api/resolver/circulation/loans/{loan_pid}/"
-        "patron".format(
-            scheme=current_app.config["JSONSCHEMAS_URL_SCHEME"],
-            host=current_app.config["JSONSCHEMAS_HOST"],
-            loan_pid=loan_pid,
+        "$ref": (
+            "{scheme}://{host}/api/resolver/circulation/loans/{loan_pid}/"
+            "patron".format(
+                scheme=current_app.config["JSONSCHEMAS_URL_SCHEME"],
+                host=current_app.config["JSONSCHEMAS_HOST"],
+                loan_pid=loan_pid,
+            )
         )
     }
 
@@ -44,19 +48,21 @@ def circulation_build_patron_ref(loan_pid, loan):
 def circulation_build_document_ref(loan_pid, loan):
     """Build $ref for the Document attached to the Loan."""
     return {
-        "$ref": "{scheme}://{host}/api/resolver/circulation/loans/{loan_pid}/"
-        "document".format(
-            scheme=current_app.config["JSONSCHEMAS_URL_SCHEME"],
-            host=current_app.config["JSONSCHEMAS_HOST"],
-            loan_pid=loan_pid,
+        "$ref": (
+            "{scheme}://{host}/api/resolver/circulation/loans/{loan_pid}/"
+            "document".format(
+                scheme=current_app.config["JSONSCHEMAS_URL_SCHEME"],
+                host=current_app.config["JSONSCHEMAS_HOST"],
+                loan_pid=loan_pid,
+            )
         )
     }
 
 
 def circulation_default_extension_max_count(loan):
     """Return a default extensions max count."""
-    is_admin_or_librarian = (
-        has_request_context() and backoffice_permission().allows(g.identity)
+    is_admin_or_librarian = has_request_context() and backoffice_permission().allows(
+        g.identity
     )
     if is_admin_or_librarian:
         unlimited = loan.get("extension_count", 0) + 1

invenio_app_ils/circulation/views.py

@@ -7,7 +7,7 @@
 
 """Invenio App ILS Circulation views."""
 
-from flask import Blueprint, abort
+from flask import Blueprint, abort, request
 from flask_login import current_user
 from invenio_circulation.links import loan_links_factory
 from invenio_circulation.pidstore.pids import CIRCULATION_LOAN_PID_TYPE
@@ -18,11 +18,24 @@ from invenio_rest import ContentNegotiatedMethodView
 from invenio_app_ils.circulation.loaders import (
     loan_checkout_loader,
     loan_request_loader,
+    loan_self_checkout_loader,
     loan_update_dates_loader,
     loans_bulk_update_loader,
 )
 from invenio_app_ils.circulation.utils import circulation_overdue_loan_days
-from invenio_app_ils.errors import OverdueLoansNotificationError
+from invenio_app_ils.errors import (
+    DocumentOverbookedError,
+    ItemCannotCirculateError,
+    ItemHasActiveLoanError,
+    ItemNotFoundError,
+    LoanSelfCheckoutDocumentOverbooked,
+    LoanSelfCheckoutItemActiveLoan,
+    LoanSelfCheckoutItemInvalidStatus,
+    LoanSelfCheckoutItemNotFound,
+    MissingRequiredParameterError,
+    OverdueLoansNotificationError,
+)
+from invenio_app_ils.items.api import ITEM_PID_TYPE
 from invenio_app_ils.permissions import need_permissions
 
 from ..patrons.api import patron_exists
@@ -30,6 +43,8 @@ from .api import (
     bulk_extend_loans,
     checkout_loan,
     request_loan,
+    self_checkout,
+    self_checkout_get_item_by_barcode,
     update_dates_loan,
 )
 from .notifications.api import (
@@ -48,81 +63,97 @@ def create_circulation_blueprint(app):
         url_prefix="",
     )
 
-    endpoints = app.config.get("RECORDS_REST_ENDPOINTS", [])
-    options = endpoints.get(CIRCULATION_LOAN_PID_TYPE, {})
+    options = app.config["RECORDS_REST_ENDPOINTS"][CIRCULATION_LOAN_PID_TYPE]
     default_media_type = options.get("default_media_type", "")
     rec_serializers = options.get("record_serializers", {})
     serializers = {
-        mime: obj_or_import_string(func)
-        for mime, func in rec_serializers.items()
-    }
-
-    bulk_loan_extension_serializers = {
-        "application/json":
-            bulk_extend_v1_response
+        mime: obj_or_import_string(func) for mime, func in rec_serializers.items()
     }
 
+    # /request
     loan_request = LoanRequestResource.as_view(
         LoanRequestResource.view_name,
         serializers=serializers,
         default_media_type=default_media_type,
         ctx=dict(links_factory=loan_links_factory, loader=loan_request_loader),
     )
-
     blueprint.add_url_rule(
         "/circulation/loans/request", view_func=loan_request, methods=["POST"]
     )
 
+    # /checkout
     loan_checkout = LoanCheckoutResource.as_view(
         LoanCheckoutResource.view_name,
         serializers=serializers,
         default_media_type=default_media_type,
-        ctx=dict(
-            links_factory=loan_links_factory, loader=loan_checkout_loader
-        ),
+        ctx=dict(links_factory=loan_links_factory, loader=loan_checkout_loader),
     )
-
     blueprint.add_url_rule(
         "/circulation/loans/checkout",
         view_func=loan_checkout,
         methods=["POST"],
     )
 
+    # /self-checkout
+    item_rec_serializers = app.config["RECORDS_REST_ENDPOINTS"][ITEM_PID_TYPE].get(
+        "record_serializers", {}
+    )
+    item_serializers = {
+        mime: obj_or_import_string(func) for mime, func in item_rec_serializers.items()
+    }
+    loan_self_checkout_item = LoanSelfCheckoutResource.as_view(
+        LoanSelfCheckoutResource.view_name,
+        serializers={},  # required, even if `method_serializers` will override it
+        method_serializers={
+            "GET": item_serializers,
+            "POST": serializers,  # default loan serializers
+        },
+        default_media_type=default_media_type,
+        ctx=dict(
+            loan_links_factory=loan_links_factory, loader=loan_self_checkout_loader
+        ),
+    )
+    blueprint.add_url_rule(
+        "/circulation/loans/self-checkout",
+        view_func=loan_self_checkout_item,
+        methods=["GET", "POST"],
+    )
+
+    # /notification-overdue
     loan_notification_overdue = LoanNotificationResource.as_view(
         LoanNotificationResource.view_name.format(CIRCULATION_LOAN_PID_TYPE),
         serializers=serializers,
         default_media_type=default_media_type,
         ctx=dict(links_factory=loan_links_factory),
     )
-
     blueprint.add_url_rule(
         "{0}/notification-overdue".format(options["item_route"]),
         view_func=loan_notification_overdue,
         methods=["POST"],
     )
 
+    # /bulk-extend
+    bulk_loan_extension_serializers = {"application/json": bulk_extend_v1_response}
+
     bulk_loan_extension = BulkLoanExtensionResource.as_view(
         BulkLoanExtensionResource.view_name,
         serializers=bulk_loan_extension_serializers,
         default_media_type=default_media_type,
         ctx=dict(loader=loans_bulk_update_loader),
     )
-
     blueprint.add_url_rule(
         "/circulation/bulk-extend",
         view_func=bulk_loan_extension,
         methods=["POST"],
     )
 
+    # /update-dates
     loan_update = LoanUpdateDatesResource.as_view(
         LoanUpdateDatesResource.view_name.format(CIRCULATION_LOAN_PID_TYPE),
         serializers=serializers,
         default_media_type=default_media_type,
-        ctx=dict(
-            links_factory=loan_links_factory, loader=loan_update_dates_loader
-        ),
+        ctx=dict(links_factory=loan_links_factory, loader=loan_update_dates_loader),
     )
-
     blueprint.add_url_rule(
         "{0}/update-dates".format(options["item_route"]),
         view_func=loan_update,
@@ -153,9 +184,7 @@ class LoanRequestResource(IlsCirculationResource):
         data = self.loader()
         pid, loan = request_loan(**data)
 
-        return self.make_response(
-            pid, loan, 202, links_factory=self.links_factory
-        )
+        return self.make_response(pid, loan, 202, links_factory=self.links_factory)
 
 
 class LoanCheckoutResource(IlsCirculationResource):
@@ -169,9 +198,51 @@ class LoanCheckoutResource(IlsCirculationResource):
         data = self.loader()
         pid, loan = checkout_loan(**data)
 
-        return self.make_response(
-            pid, loan, 202, links_factory=self.links_factory
-        )
+        return self.make_response(pid, loan, 202, links_factory=self.links_factory)
+
+
+class LoanSelfCheckoutResource(IlsCirculationResource):
+    """Loan self-checkout action resource."""
+
+    view_name = "loan_self_checkout"
+
+    @need_permissions("circulation-loan-self-checkout")
+    def get(self, **kwargs):
+        """Loan self-checkout GET method to retrieve items."""
+        try:
+            barcode = request.args["barcode"].upper()
+            assert barcode
+        except (KeyError, AssertionError):
+            msg = "Parameter `barcode` is missing"
+            raise MissingRequiredParameterError(description=msg)
+
+        try:
+            pid, item = self_checkout_get_item_by_barcode(barcode)
+        except ItemCannotCirculateError:
+            raise LoanSelfCheckoutItemInvalidStatus()
+        except ItemHasActiveLoanError:
+            raise LoanSelfCheckoutItemActiveLoan()
+        except DocumentOverbookedError:
+            raise LoanSelfCheckoutDocumentOverbooked()
+        except ItemNotFoundError:
+            raise LoanSelfCheckoutItemNotFound()
+
+        return self.make_response(pid, item, 200)
+
+    @need_permissions("circulation-loan-self-checkout")
+    def post(self, **kwargs):
+        """Loan self-checkout POST method to perform the checkout."""
+        data = self.loader()
+        try:
+            pid, loan = self_checkout(**data)
+        except ItemCannotCirculateError:
+            raise LoanSelfCheckoutItemInvalidStatus()
+        except ItemHasActiveLoanError:
+            raise LoanSelfCheckoutItemActiveLoan()
+        except DocumentOverbookedError:
+            raise LoanSelfCheckoutDocumentOverbooked()
+
+        return self.make_response(pid, loan, 202, links_factory=self.loan_links_factory)
 
 
 class BulkLoanExtensionResource(IlsCirculationResource):
@@ -190,9 +261,7 @@ class BulkLoanExtensionResource(IlsCirculationResource):
         extended_loans, not_extended_loans = bulk_extend_loans(**data)
         if extended_loans:
             send_bulk_extend_notification(
-                extended_loans,
-                not_extended_loans,
-                patron_pid=data["patron_pid"]
+                extended_loans, not_extended_loans, patron_pid=data["patron_pid"]
             )
         return self.make_response(extended_loans, not_extended_loans, 202)
 
@@ -209,15 +278,12 @@ class LoanNotificationResource(IlsCirculationResource):
         days_ago = circulation_overdue_loan_days(record)
         is_overdue = days_ago > 0
         if not is_overdue:
-            raise OverdueLoansNotificationError(
-                description="This loan is not overdue")
+            raise OverdueLoansNotificationError(description="This loan is not overdue")
         send_loan_overdue_reminder_notification(
             record, days_ago, is_manually_triggered=True
         )
 
-        return self.make_response(
-            pid, record, 202, links_factory=self.links_factory
-        )
+        return self.make_response(pid, record, 202, links_factory=self.links_factory)
 
 
 class LoanUpdateDatesResource(IlsCirculationResource):
@@ -232,6 +298,4 @@ class LoanUpdateDatesResource(IlsCirculationResource):
         data = self.loader()
         update_dates_loan(record, **data)
 
-        return self.make_response(
-            pid, record, 202, links_factory=self.links_factory
-        )
+        return self.make_response(pid, record, 202, links_factory=self.links_factory)