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

invenio_app_ils/eitems/api.py

@@ -57,14 +57,18 @@ class EItemValidator(RecordValidator):
 class EItem(IlsRecord):
     """EItem record class."""
 
+    EITEM_TYPES = [
+        "E-BOOK",
+        "AUDIOBOOK",
+        "VIDEO",
+    ]
+
     _pid_type = EITEM_PID_TYPE
-    _schema = "eitems/eitem-v1.0.0.json"
+    _schema = "eitems/eitem-v3.0.0.json"
     _document_resolver_path = (
         "{scheme}://{host}/api/resolver/eitems/{eitem_pid}/document"
     )
-    _files_resolver_path = (
-        "{scheme}://{host}/api/resolver/eitems/{eitem_pid}/files"
-    )
+    _files_resolver_path = "{scheme}://{host}/api/resolver/eitems/{eitem_pid}/files"
     _validator = EItemValidator()
 
     @classmethod
@@ -113,7 +117,37 @@ class EItem(IlsRecord):
 def eitem_event_builder(event, sender_app, obj=None, **kwargs):
     """Add eitem metadata to the event."""
     record = kwargs["record"]
-    event.update(
-        dict(eitem_pid=record["pid"], document_pid=record.get("document_pid"))
-    )
+    event.update(dict(eitem_pid=record["pid"], document_pid=record.get("document_pid")))
     return event
+
+
+def get_eitems_for_document_by_creator(document_pid, creator, case_insensitive=False):
+    """Find eitems by document pid and creator.
+
+    :param document_pid: The PID of the document of the eitems to search for.
+    :param creator: The creator to filter eitems by.
+    :param case_insensitive: Whether the creator match should be case insensitive.
+    """
+    eitem_search = current_app_ils.eitem_search_cls()
+    creator_match = eitem_search.search_by_document_pid(
+        document_pid=document_pid
+    ).filter(
+        "term",
+        created_by__value={"value": creator, "case_insensitive": case_insensitive},
+    )
+
+    return creator_match
+
+
+def get_eitems_for_document_by_source(document_pid, source, case_insensitive=False):
+    """Find eitems by document pid and source.
+
+    :param document_pid: The PID of the document of the eitems to search for.
+    :param source: The source to filter eitems by.
+    :param case_insensitive: Whether the source match should be case insensitive.
+    """
+    eitem_search = current_app_ils.eitem_search_cls()
+    source_match = eitem_search.search_by_document_pid(
+        document_pid=document_pid
+    ).filter("term", source={"value": source, "case_insensitive": case_insensitive})
+    return source_match

invenio_app_ils/eitems/loaders/jsonschemas/eitems.py

@@ -8,15 +8,14 @@
 """EItems schema for marshmallow loader."""
 
 from invenio_records_rest.schemas import RecordMetadataSchemaJSONV1
-from marshmallow import EXCLUDE, Schema, fields, pre_load
+from marshmallow import EXCLUDE, Schema, fields, pre_load, validate
 
-from invenio_app_ils.documents.loaders.jsonschemas.document import (
-    IdentifierSchema,
-)
+from invenio_app_ils.eitems.api import EItem
 from invenio_app_ils.records.loaders.schemas.changed_by import (
     ChangedBySchema,
     set_changed_by,
 )
+from invenio_app_ils.records.loaders.schemas.identifiers import IdentifierSchema
 
 
 class URLSchema(Schema):
@@ -28,7 +27,7 @@ class URLSchema(Schema):
         unknown = EXCLUDE
 
     description = fields.Str()
-    login_required = fields.Bool(missing=True)
+    login_required = fields.Bool(load_default=True)
     value = fields.URL(required=True)
 
 
@@ -60,10 +59,11 @@ class EItemSchemaV1(RecordMetadataSchemaJSONV1):
     created_by = fields.Nested(ChangedBySchema)
     description = fields.Str()
     document_pid = fields.Str(required=True)
+    eitem_type = fields.Str(required=True, validate=validate.OneOf(EItem.EITEM_TYPES))
     files = fields.List(fields.Nested(FileSchema))
     identifiers = fields.List(fields.Nested(IdentifierSchema))
     internal_notes = fields.Str()
-    open_access = fields.Bool(missing=True)
+    open_access = fields.Bool(load_default=True)
     source = fields.Str()
     urls = fields.List(fields.Nested(URLSchema))
 

invenio_app_ils/eitems/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.
 
-"""ILS eitems ES v6 mappings."""
+"""ILS eitems ES v7 mappings."""

invenio_app_ils/eitems/mappings/os-v1/eitems/eitem-v1.0.0.json

@@ -0,0 +1,139 @@
+{
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "_created": {
+        "type": "date"
+      },
+      "_updated": {
+        "type": "date"
+      },
+      "bucket_id": {
+        "type": "keyword"
+      },
+      "created_by": {
+        "properties": {
+          "type": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "description": {
+        "type": "text"
+      },
+      "document": {
+        "properties": {
+          "authors": {
+            "type": "text"
+          },
+          "cover_metadata": {
+            "properties": {},
+            "type": "object"
+          },
+          "edition": {
+            "type": "text"
+          },
+          "pid": {
+            "type": "keyword"
+          },
+          "publication_year": {
+            "type": "keyword"
+          },
+          "title": {
+            "type": "text",
+            "fields": {
+              "keyword": {
+                "type": "keyword"
+              }
+            }
+          }
+        },
+        "type": "object"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "files": {
+        "properties": {
+          "bucket": {
+            "type": "keyword"
+          },
+          "checksum": {
+            "type": "keyword"
+          },
+          "file_id": {
+            "type": "keyword"
+          },
+          "key": {
+            "type": "keyword"
+          },
+          "size": {
+            "type": "keyword"
+          },
+          "version_id": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "identifiers": {
+        "properties": {
+          "material": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword",
+            "fields": {
+              "text": {
+                "type": "text"
+              }
+            }
+          }
+        },
+        "type": "object"
+      },
+      "internal_notes": {
+        "type": "text"
+      },
+      "open_access": {
+        "type": "boolean"
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "source": {
+        "type": "keyword",
+        "fields": {
+          "text": {
+            "type": "text"
+          }
+        }
+      },
+      "urls": {
+        "properties": {
+          "description": {
+            "type": "text"
+          },
+          "value": {
+            "type": "keyword"
+          },
+          "login_required": {
+            "type": "boolean"
+          }
+        },
+        "type": "object"
+      }
+    }
+  }
+}

invenio_app_ils/eitems/mappings/os-v1/eitems/eitem-v2.0.0.json

@@ -0,0 +1,142 @@
+{
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "_created": {
+        "type": "date"
+      },
+      "_updated": {
+        "type": "date"
+      },
+      "bucket_id": {
+        "type": "keyword"
+      },
+      "created_by": {
+        "properties": {
+          "type": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "description": {
+        "type": "text"
+      },
+      "document": {
+        "properties": {
+          "authors": {
+            "type": "text"
+          },
+          "cover_metadata": {
+            "properties": {},
+            "type": "object"
+          },
+          "edition": {
+            "type": "text"
+          },
+          "pid": {
+            "type": "keyword"
+          },
+          "publication_year": {
+            "type": "keyword"
+          },
+          "title": {
+            "type": "text",
+            "fields": {
+              "keyword": {
+                "type": "keyword"
+              }
+            }
+          }
+        },
+        "type": "object"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "eitem_type": {
+        "type": "keyword"
+      },
+      "files": {
+        "properties": {
+          "bucket": {
+            "type": "keyword"
+          },
+          "checksum": {
+            "type": "keyword"
+          },
+          "file_id": {
+            "type": "keyword"
+          },
+          "key": {
+            "type": "keyword"
+          },
+          "size": {
+            "type": "keyword"
+          },
+          "version_id": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "identifiers": {
+        "properties": {
+          "material": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword",
+            "fields": {
+              "text": {
+                "type": "text"
+              }
+            }
+          }
+        },
+        "type": "object"
+      },
+      "internal_notes": {
+        "type": "text"
+      },
+      "open_access": {
+        "type": "boolean"
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "source": {
+        "type": "keyword",
+        "fields": {
+          "text": {
+            "type": "text"
+          }
+        }
+      },
+      "urls": {
+        "properties": {
+          "description": {
+            "type": "text"
+          },
+          "value": {
+            "type": "keyword"
+          },
+          "login_required": {
+            "type": "boolean"
+          }
+        },
+        "type": "object"
+      }
+    }
+  }
+}

invenio_app_ils/eitems/mappings/os-v1/eitems/eitem-v3.0.0.json

@@ -0,0 +1,179 @@
+{
+  "settings": {
+    "analysis": {
+      "normalizer": {
+        "custom_normalizer": {
+          "type": "custom",
+          "char_filter": ["strip_special_chars"],
+          "filter": ["lowercase", "asciifolding"]
+        }
+      },
+      "analyzer": {
+        "custom_analyzer": {
+          "tokenizer": "standard",
+          "type": "custom",
+          "char_filter": ["strip_special_chars"],
+          "filter": ["lowercase", "asciifolding"]
+        }
+      },
+      "filter": {
+        "asciifolding": {
+          "type": "asciifolding"
+        }
+      },
+      "char_filter": {
+        "strip_special_chars": {
+          "type": "pattern_replace",
+          "pattern": "[\\p{Punct}\\p{S}]",
+          "replacement": ""
+        }
+      }
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "numeric_detection": false,
+    "properties": {
+      "$schema": {
+        "type": "keyword"
+      },
+      "_created": {
+        "type": "date"
+      },
+      "_updated": {
+        "type": "date"
+      },
+      "bucket_id": {
+        "type": "keyword"
+      },
+      "created_by": {
+        "properties": {
+          "type": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "description": {
+        "type": "text"
+      },
+      "document": {
+        "properties": {
+          "authors": {
+            "type": "text"
+          },
+          "cover_metadata": {
+            "properties": {},
+            "type": "object"
+          },
+          "edition": {
+            "type": "text"
+          },
+          "pid": {
+            "type": "keyword"
+          },
+          "publication_year": {
+            "type": "keyword"
+          },
+          "title": {
+            "type": "text",
+            "fields": {
+              "keyword": {
+                "type": "keyword"
+              },
+              "normalized_keyword": {
+                "type": "keyword",
+                "normalizer": "custom_normalizer"
+              }
+            },
+            "analyzer": "custom_analyzer",
+            "search_analyzer": "custom_analyzer"
+          }
+        },
+        "type": "object"
+      },
+      "document_pid": {
+        "type": "keyword"
+      },
+      "eitem_type": {
+        "type": "keyword"
+      },
+      "files": {
+        "properties": {
+          "bucket": {
+            "type": "keyword"
+          },
+          "checksum": {
+            "type": "keyword"
+          },
+          "file_id": {
+            "type": "keyword"
+          },
+          "key": {
+            "type": "keyword"
+          },
+          "size": {
+            "type": "keyword"
+          },
+          "version_id": {
+            "type": "keyword"
+          }
+        },
+        "type": "object"
+      },
+      "identifiers": {
+        "properties": {
+          "material": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          },
+          "value": {
+            "type": "keyword",
+            "fields": {
+              "text": {
+                "type": "text"
+              }
+            }
+          }
+        },
+        "type": "object"
+      },
+      "internal_notes": {
+        "type": "text"
+      },
+      "open_access": {
+        "type": "boolean"
+      },
+      "pid": {
+        "type": "keyword"
+      },
+      "source": {
+        "type": "keyword",
+        "fields": {
+          "text": {
+            "type": "text"
+          }
+        }
+      },
+      "urls": {
+        "properties": {
+          "description": {
+            "type": "text"
+          },
+          "value": {
+            "type": "keyword"
+          },
+          "login_required": {
+            "type": "boolean"
+          }
+        },
+        "type": "object"
+      }
+    }
+  }
+}

invenio_app_ils/{series/mappings/v6 → eitems/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.
 
-"""ILS series ES v6 mappings."""
+"""ILS eitems ES v7 mappings."""