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

invenio_app_ils/ext.py

@@ -23,7 +23,7 @@ from .circulation import config as circulation_config
 from .circulation.indexer import index_extra_fields_for_loan
 from .circulation.receivers import register_circulation_signals
 from .document_requests.api import DOCUMENT_REQUEST_PID_TYPE
-from .documents.api import DOCUMENT_PID_TYPE
+from .documents.api import DOCUMENT_PID_TYPE, Document
 from .eitems.api import EITEM_PID_TYPE
 from .files.receivers import register_files_signals
 from .internal_locations.api import INTERNAL_LOCATION_PID_TYPE
@@ -68,16 +68,16 @@ class _InvenioAppIlsState(object):
         return pid.pid_value, pid
 
     def record_class_by_pid_type(self, pid_type):
-        endpoints = current_app.config.get("RECORDS_REST_ENDPOINTS", {})
+        endpoints = current_app.config["RECORDS_REST_ENDPOINTS"]
         return endpoints[pid_type]["record_class"]
 
     def indexer_by_pid_type(self, pid_type):
-        endpoints = current_app.config.get("RECORDS_REST_ENDPOINTS", {})
+        endpoints = current_app.config["RECORDS_REST_ENDPOINTS"]
         _cls = endpoints[pid_type]["indexer_class"]
         return _cls()
 
     def search_by_pid_type(self, pid_type):
-        endpoints = current_app.config.get("RECORDS_REST_ENDPOINTS", {})
+        endpoints = current_app.config["RECORDS_REST_ENDPOINTS"]
         return endpoints[pid_type]["search_class"]
 
     @cached_property
@@ -244,25 +244,26 @@ class InvenioAppIls(object):
         # disable warnings being logged to Sentry
         logging.getLogger("py.warnings").propagate = False
 
+        # each production instance has its own post-logout configuration
+        if app.config["DEBUG"]:
+            app.config["SECURITY_POST_LOGOUT_VIEW"] = "/logged-out"
+
     def init_metadata_extensions(self, app):
         """Metadata extensions initialization."""
         for rec_type in app.config["ILS_RECORDS_METADATA_EXTENSIONS"].keys():
-            namespaces = app.config["ILS_RECORDS_METADATA_NAMESPACES"].get(
-                rec_type, {}
-            )
-            extensions = app.config["ILS_RECORDS_METADATA_EXTENSIONS"].get(
-                rec_type, {}
-            )
+            namespaces = app.config["ILS_RECORDS_METADATA_NAMESPACES"].get(rec_type, {})
+            extensions = app.config["ILS_RECORDS_METADATA_EXTENSIONS"].get(rec_type, {})
+            rec_schema = extensions.get("schema", "{0}s-{0}-v1.0.0".format(rec_type))
             setattr(
                 app.extensions["invenio-app-ils"],
                 "{}_metadata_extensions".format(rec_type),
-                MetadataExtensions(namespaces, extensions),
+                MetadataExtensions(namespaces, extensions["fields"]),
             )
             before_record_index.dynamic_connect(
                 before_record_index_hook,
                 sender=app,
                 weak=False,
-                index="{0}s-{0}-v1.0.0".format(rec_type),
+                index=rec_schema.replace("/", "-").rstrip(".json"),
             )
 
     def init_loan_indexer_hook(self, app):
@@ -304,9 +305,7 @@ class InvenioAppIlsREST(InvenioAppIls):
             register_location_signals()
 
 
-def before_record_index_hook(
-    sender, json=None, record=None, index=None, **kwargs
-):
+def before_record_index_hook(sender, json=None, record=None, index=None, **kwargs):
     """Hook to transform record before indexing in ES.
 
     :param sender: The entity sending the signal.
@@ -318,9 +317,7 @@ def before_record_index_hook(
     add_es_metadata_extensions(json)  # mutates json
 
 
-def before_loan_index_hook(
-    sender, json=None, record=None, index=None, **kwargs
-):
+def before_loan_index_hook(sender, json=None, record=None, index=None, **kwargs):
     """Hook to transform loan record before ES indexing.
 
     :param sender: The entity sending the signal.

invenio_app_ils/facets.py

@@ -8,8 +8,8 @@
 """Facets and factories for result filtering and aggregation."""
 
 import arrow
-from elasticsearch_dsl.query import Bool, Q, Range
 from flask import current_app
+from invenio_search.engine import dsl
 
 
 def keyed_range_filter(field, range_query, **kwargs):
@@ -27,8 +27,7 @@ def keyed_range_filter(field, range_query, **kwargs):
                     args[key] = value
 
         args.update(kwargs.copy())
-
-        return Range(**{field: args})
+        return dsl.query.Range(**{field: args})
 
     return inner
 
@@ -43,9 +42,9 @@ def default_value_when_missing_filter(field, missing_val):
 
     def inner(values):
         if missing_val in values:
-            return Bool(**{"must_not": {"exists": {"field": field}}})
+            return dsl.query.Bool(**{"must_not": {"exists": {"field": field}}})
         else:
-            return Q("terms", **{field: values})
+            return dsl.Q("terms", **{field: values})
 
     return inner
 
@@ -59,9 +58,9 @@ def exists_value_filter(field, filter_value):
 
     def inner(values):
         if filter_value in values:
-            return Bool(**{"must": {"exists": {"field": field}}})
+            return dsl.query.Bool(**{"must": {"exists": {"field": field}}})
         else:
-            return Bool(**{"must_not": {"exists": {"field": field}}})
+            return dsl.query.Bool(**{"must_not": {"exists": {"field": field}}})
 
     return inner
 
@@ -91,12 +90,13 @@ def overdue_loans_filter(field):
             if range_key in values:
                 for key, value in mappings.items():
                     args[key] = value
-
-        return Range(**{field: args}) & Q(
-            "terms",
-            **{"state": current_app.config["CIRCULATION_STATES_LOAN_ACTIVE"]}
+        range_query = dsl.query.Range(**{field: args})
+        terms_query = dsl.Q(
+            "terms", **{"state": current_app.config["CIRCULATION_STATES_LOAN_ACTIVE"]}
         )
 
+        return dsl.query.Bool(must=[range_query, terms_query])
+
     return inner
 
 
@@ -104,9 +104,7 @@ def overdue_agg():
     """Create a custom aggregation with dynamic dates."""
     return dict(
         filter=dict(
-            terms=dict(
-                state=current_app.config["CIRCULATION_STATES_LOAN_ACTIVE"]
-            )
+            terms=dict(state=current_app.config["CIRCULATION_STATES_LOAN_ACTIVE"])
         ),
         aggs=dict(
             end_date=dict(
@@ -142,6 +140,6 @@ def date_range_filter(field, comparator):
             input_date = str(arrow.get(values[0]).date())
         except arrow.parser.ParserError:
             raise ValueError("Input should be a date")
-        return Range(**{field: {comparator: input_date}})
+        return dsl.RangeField(**{field: {comparator: input_date}})
 
     return inner

invenio_app_ils/files/receivers.py

@@ -14,7 +14,7 @@ from invenio_files_rest.signals import file_deleted, file_uploaded
 from invenio_app_ils.eitems.indexer import index_eitem_after_files_changed
 
 
-def on_file_changed(obj):
+def on_file_changed(sender, obj=None):
     """Index eitems after files changed."""
     eta = arrow.utcnow() + current_app.config["ILS_INDEXER_TASK_DELAY"]
     index_eitem_after_files_changed.apply_async([str(obj.bucket_id)], eta=eta)

invenio_app_ils/files/views.py

@@ -27,8 +27,7 @@ def create_files_blueprint(app):
     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()
+        mime: obj_or_import_string(func) for mime, func in rec_serializers.items()
     }
     record_bucket_view = RecordBucketResource.as_view(
         RecordBucketResource.view_name.format(EITEM_PID_TYPE),

invenio_app_ils/ill/api.py

@@ -125,8 +125,7 @@ class BorrowingRequest(IlsRecord):
         "borrowing-requests/{brw_req_pid}/provider"
     )
     _patron_resolver_path = (
-        "{scheme}://{host}/api/resolver/ill/"
-        "borrowing-requests/{brw_req_pid}/patron"
+        "{scheme}://{host}/api/resolver/ill/" "borrowing-requests/{brw_req_pid}/patron"
     )
     STATUSES = ["PENDING", "REQUESTED", "ON_LOAN", "RETURNED", "CANCELLED"]
     EXTENSION_STATUSES = ["PENDING", "DECLINED"]

invenio_app_ils/ill/config.py

@@ -11,7 +11,7 @@ from invenio_records_rest.facets import terms_filter
 
 from invenio_app_ils.config import RECORDS_REST_MAX_RESULT_WINDOW
 from invenio_app_ils.permissions import (
-    PatronOwnerPermission,
+    PatronOwnerReadPermission,
     authenticated_user_permission,
     backoffice_permission,
     superuser_permission,
@@ -29,7 +29,9 @@ from .search import BorrowingRequestsSearch
 ###############################################################################
 # ILS ILL
 ###############################################################################
-ILS_ILL_NOTIFICATIONS_MSG_BUILDER = "invenio_app_ils.ill.notifications.messages:notification_ill_msg_builder"  # noqa
+ILS_ILL_NOTIFICATIONS_MSG_BUILDER = (
+    "invenio_app_ils.ill.notifications.messages:notification_ill_msg_builder"  # noqa
+)
 # Override default templates
 ILS_ILL_NOTIFICATIONS_TEMPLATES = {}
 # Function to select and filter which notifications should be sent
@@ -54,20 +56,14 @@ RECORDS_REST_ENDPOINTS = dict(
         indexer_class=RecordIndexer,
         record_class=BorrowingRequest,
         record_loaders={
-            "application/json": (
-                "invenio_app_ils.ill.loaders:borrowing_request_loader"
-            )
+            "application/json": "invenio_app_ils.ill.loaders:borrowing_request_loader"
         },
         record_serializers={
-            "application/json": (
-                "invenio_app_ils.ill.serializers:json_v1_response"
-            )
+            "application/json": "invenio_app_ils.ill.serializers:json_v1_response"
         },
         search_serializers={
-            "application/json": (
-                "invenio_app_ils.ill.serializers:json_v1_search"
-            ),
-            "text/csv": ("invenio_app_ils.ill.serializers:csv_v1_search"),
+            "application/json": "invenio_app_ils.ill.serializers:json_v1_search",
+            "text/csv": "invenio_app_ils.ill.serializers:csv_v1_search",
         },
         search_serializers_aliases={
             "csv": "text/csv",
@@ -80,7 +76,7 @@ RECORDS_REST_ENDPOINTS = dict(
         default_media_type="application/json",
         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=backoffice_permission,
@@ -122,9 +118,7 @@ RECORDS_REST_FACETS = dict(
         aggs=dict(
             status=dict(terms=dict(field="status")),
             provider=dict(
-                terms=dict(
-                    field="provider.name.keyword", size=FACET_PROVIDER_LIMIT
-                )
+                terms=dict(field="provider.name.keyword", size=FACET_PROVIDER_LIMIT)
             ),
             patron_loan_extension=dict(
                 terms=dict(field="patron_loan.extension.status")

invenio_app_ils/ill/jsonresolvers/borrowing_request_document.py

@@ -41,6 +41,7 @@ def jsonresolver_loader(url_map):
             "pid",
             "publication_year",
             "title",
+            "alternative_titles",
         )
         obj["authors"] = flatten_authors(obj["authors"])
         return obj
@@ -48,9 +49,7 @@ def jsonresolver_loader(url_map):
     def borrowing_request_resolver(request_pid):
         """Return the Document record for the given Brw Request or raise."""
         request_record_cls = current_ils_ill.borrowing_request_record_cls
-        document_pid = get_field_value(
-            request_record_cls, request_pid, "document_pid"
-        )
+        document_pid = get_field_value(request_record_cls, request_pid, "document_pid")
         return get_document(document_pid)
 
     url_map.add(

invenio_app_ils/ill/jsonresolvers/borrowing_request_patron.py

@@ -31,9 +31,7 @@ def jsonresolver_loader(url_map):
     def borrowing_request_resolver(request_pid):
         """Return the Patron record for the given Brw Request or raise."""
         request_record_cls = current_ils_ill.borrowing_request_record_cls
-        patron_pid = get_field_value(
-            request_record_cls, request_pid, "patron_pid"
-        )
+        patron_pid = get_field_value(request_record_cls, request_pid, "patron_pid")
 
         return get_patron_or_unknown_dump(patron_pid)
 

invenio_app_ils/ill/jsonresolvers/borrowing_request_provider.py

@@ -31,9 +31,7 @@ def jsonresolver_loader(url_map):
     def borrowing_request_resolver(request_pid):
         """Return the Provider record for the given Brw Request or raise."""
         request_record_cls = current_ils_ill.borrowing_request_record_cls
-        provider_pid = get_field_value(
-            request_record_cls, request_pid, "provider_pid"
-        )
+        provider_pid = get_field_value(request_record_cls, request_pid, "provider_pid")
 
         provider_record_cls = current_ils_prov.provider_record_cls
         provider = provider_record_cls.get_record_by_pid(provider_pid)

invenio_app_ils/ill/loaders/__init__.py

@@ -19,12 +19,6 @@ from .jsonschemas.patron_loan_extension_actions import (
 
 borrowing_request_loader = ils_marshmallow_loader(BorrowingRequestSchemaV1)
 patron_loan_create_action_loader = ils_marshmallow_loader(CreateLoanSchemaV1)
-patron_loan_extension_request_loader = ils_marshmallow_loader(
-    RequestExtensionSchemaV1
-)
-patron_loan_extension_accept_loader = ils_marshmallow_loader(
-    AcceptExtensionSchemaV1
-)
-patron_loan_extension_decline_loader = ils_marshmallow_loader(
-    DeclineExtensionSchemaV1
-)
+patron_loan_extension_request_loader = ils_marshmallow_loader(RequestExtensionSchemaV1)
+patron_loan_extension_accept_loader = ils_marshmallow_loader(AcceptExtensionSchemaV1)
+patron_loan_extension_decline_loader = ils_marshmallow_loader(DeclineExtensionSchemaV1)

invenio_app_ils/ill/loaders/jsonschemas/patron_loan_actions.py

@@ -10,14 +10,7 @@
 import arrow
 from invenio_circulation.records.loaders.schemas.json import DateString
 from invenio_rest.serializer import BaseSchema as InvenioBaseSchema
-from marshmallow import (
-    EXCLUDE,
-    ValidationError,
-    fields,
-    post_load,
-    pre_load,
-    validates,
-)
+from marshmallow import EXCLUDE, ValidationError, fields, post_load, pre_load, validates
 
 from invenio_app_ils.circulation.loaders.schemas.json.base import (
     transaction_location_pid_validator,

invenio_app_ils/ill/loaders/jsonschemas/patron_loan_extension_actions.py

@@ -21,13 +21,9 @@ from invenio_app_ils.ill.api import BorrowingRequest
 def validate_statuses(record):
     """Validate that the extension action can be performed."""
     if record["status"] != "ON_LOAN":
-        raise ValidationError(
-            "This interlibrary loan is currently not on loan."
-        )
+        raise ValidationError("This interlibrary loan is currently not on loan.")
 
-    ext_status = (
-        record.get("patron_loan", {}).get("extension", {}).get("status")
-    )
+    ext_status = record.get("patron_loan", {}).get("extension", {}).get("status")
     # status = None is valid, no extension requested yet
     has_status = ext_status is not None
     is_valid = ext_status in BorrowingRequest.EXTENSION_STATUSES
@@ -58,8 +54,7 @@ class RequestExtensionSchemaV1(InvenioBaseSchema):
         ext_status = validate_statuses(record)
         if ext_status == "PENDING":
             raise ValidationError(
-                "An extension for this interlibrary loan has already been "
-                "requested."
+                "An extension for this interlibrary loan has already been " "requested."
             )
         elif ext_status == "DECLINED":
             raise ValidationError(

invenio_app_ils/ill/mappings/{v6 → os-v1}/__init__.py

@@ -5,4 +5,4 @@
 # 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.
 
-"""ILL ES v6 mappings."""
+"""ILL ES v7 mappings."""

invenio_app_ils/ill/mappings/os-v1/ill_borrowing_requests/borrowing_request-v1.0.0.json

@@ -0,0 +1,254 @@
+{
+  "settings": {
+    "analysis": {
+      "analyzer": {
+        "email": {
+          "type": "custom",
+          "tokenizer": "uax_url_email"
+        }
+      }
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "_created": {
+        "type": "date"
+      },
+      "_updated": {
+        "type": "date"
+      },
+      "cancel_reason": {
+        "type": "text"
+      },
+      "created_by": {
+        "properties": {
+          "type": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "document": {
+        "properties": {
+          "authors": {
+            "type": "text"
+          },
+          "cover_metadata": {
+            "properties": {},
+            "type": "object"
+          },
+          "edition": {
+            "type": "text"
+          },
+          "pid": {
+            "type": "keyword"
+          },
+          "publication_year": {
+            "type": "keyword"
+          },
+          "title": {
+            "type": "text"
+          },
+          "alternative_titles": {
+            "properties": {
+              "language": {
+                "type": "keyword"
+              },
+              "type": {
+                "type": "keyword"
+              },
+              "value": {
+                "type": "text"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "due_date": {
+        "type": "date"
+      },
+      "expected_delivery_date": {
+        "type": "date"
+      },
+      "legacy_id": {
+        "type": "keyword"
+      },
+      "provider": {
+        "properties": {
+          "name": {
+            "fields": {
+              "keyword": {
+                "type": "keyword"
+              }
+            },
+            "type": "text"
+          },
+          "pid": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "provider_pid": {
+        "type": "keyword"
+      },
+      "notes": {
+        "type": "text"
+      },
+      "patron": {
+        "properties": {
+          "email": {
+            "type": "text",
+            "analyzer": "email"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "name": {
+            "type": "text",
+            "fields": {
+              "keyword": {
+                "type": "keyword"
+              }
+            }
+          },
+          "location_pid": {
+            "type": "keyword"
+          },
+          "pid": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "patron_pid": {
+        "type": "keyword"
+      },
+      "patron_loan": {
+        "properties": {
+          "extension": {
+            "properties": {
+              "notes": {
+                "type": "text"
+              },
+              "request_date": {
+                "type": "date"
+              },
+              "status": {
+                "type": "keyword"
+              }
+            },
+            "type": "object"
+          },
+          "pid": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "payment": {
+        "properties": {
+          "budget_code": {
+            "type": "keyword"
+          },
+          "debit_cost": {
+            "properties": {
+              "currency": {
+                "type": "keyword"
+              },
+              "value": {
+                "type": "float"
+              }
+            },
+            "type": "object"
+          },
+          "debit_cost_main_currency": {
+            "properties": {
+              "currency": {
+                "type": "keyword"
+              },
+              "value": {
+                "type": "float"
+              }
+            },
+            "type": "object"
+          },
+          "debit_date": {
+            "type": "date"
+          },
+          "debit_note": {
+            "type": "text"
+          },
+          "internal_purchase_requisition_id": {
+            "type": "keyword"
+          },
+          "mode": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "received_date": {
+        "type": "date"
+      },
+      "request_date": {
+        "type": "date"
+      },
+      "status": {
+        "type": "keyword"
+      },
+      "total": {
+        "properties": {
+          "currency": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "float"
+          }
+        },
+        "type": "object"
+      },
+      "total_main_currency": {
+        "properties": {
+          "currency": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "float"
+          }
+        },
+        "type": "object"
+      },
+      "type": {
+        "type": "keyword"
+      },
+      "updated_by": {
+        "properties": {
+          "type": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      }
+    }
+  }
+}

invenio_app_ils/{acquisition/mappings/v6 → ill/mappings/os-v2}/__init__.py

@@ -5,4 +5,4 @@
 # 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.
 
-"""Invenio Acquisition ES v6 mappings."""
+"""ILL ES v7 mappings."""