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

invenio_app_ils/eitems/mappings/v7/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/eitems/schemas/eitems/eitem-v2.0.0.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Schema EItem",
+  "type": "object",
+  "required": ["$schema", "pid", "document_pid", "created_by", "eitem_type"],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "bucket_id": {
+      "type": "string",
+      "title": "The bucket identifier for this EItem"
+    },
+    "created_by": {
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "description": {
+      "type": "string",
+      "title": "Any extra description for this EItem"
+    },
+    "document_pid": {
+      "type": "string",
+      "title": "The persistent identifier of its Document"
+    },
+    "eitem_type": {
+      "title": "EItem type",
+      "type": "string"
+    },
+    "document": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "files": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "identifiers": {
+      "items": {
+        "properties": {
+          "material": {
+            "title": "Material to which the identifiers refers to.",
+            "type": "string"
+          },
+          "scheme": {
+            "title": "Scheme of the identifier (Vocabulary)",
+            "type": "string"
+          },
+          "value": {
+            "title": "Value of the identifier",
+            "type": "string"
+          }
+        },
+        "required": ["value", "scheme"]
+      },
+      "title": "List of Identifiers of the record",
+      "type": "array"
+    },
+    "internal_notes": {
+      "type": "string",
+      "title": "Any extra description for this EItem reserved for internal usage"
+    },
+    "open_access": {
+      "type": "boolean",
+      "title": "Indicate if the access to this EItem is open or not",
+      "default": true
+    },
+    "pid": {
+      "type": "string",
+      "title": "The persistent identifier of this EItem"
+    },
+    "source": {
+      "type": "string",
+      "title": "Source of the record."
+    },
+    "urls": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "description": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "value": {
+            "format": "uri",
+            "minLength": 1,
+            "type": "string"
+          },
+          "login_required": {
+            "type": "boolean",
+            "title": "Indicate if the access to this link requires login",
+            "default": false
+          }
+        },
+        "required": ["value"],
+        "title": "URL of external resource",
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    }
+  }
+}

invenio_app_ils/eitems/schemas/eitems/eitem-v3.0.0.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Schema EItem",
+  "type": "object",
+  "required": ["$schema", "pid", "document_pid", "created_by", "eitem_type"],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "bucket_id": {
+      "type": "string",
+      "title": "The bucket identifier for this EItem"
+    },
+    "created_by": {
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "description": {
+      "type": "string",
+      "title": "Any extra description for this EItem"
+    },
+    "document_pid": {
+      "type": "string",
+      "title": "The persistent identifier of its Document"
+    },
+    "eitem_type": {
+      "title": "EItem type",
+      "type": "string"
+    },
+    "document": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "files": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string"
+        }
+      }
+    },
+    "identifiers": {
+      "items": {
+        "properties": {
+          "material": {
+            "title": "Material to which the identifiers refers to.",
+            "type": "string"
+          },
+          "scheme": {
+            "title": "Scheme of the identifier (Vocabulary)",
+            "type": "string"
+          },
+          "value": {
+            "title": "Value of the identifier",
+            "type": "string"
+          }
+        },
+        "required": ["value", "scheme"]
+      },
+      "title": "List of Identifiers of the record",
+      "type": "array"
+    },
+    "internal_notes": {
+      "type": "string",
+      "title": "Any extra description for this EItem reserved for internal usage"
+    },
+    "open_access": {
+      "type": "boolean",
+      "title": "Indicate if the access to this EItem is open or not",
+      "default": true
+    },
+    "pid": {
+      "type": "string",
+      "title": "The persistent identifier of this EItem"
+    },
+    "source": {
+      "type": "string",
+      "title": "Source of the record."
+    },
+    "urls": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "description": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "value": {
+            "format": "uri",
+            "minLength": 1,
+            "type": "string"
+          },
+          "login_required": {
+            "type": "boolean",
+            "title": "Indicate if the access to this link requires login",
+            "default": false
+          }
+        },
+        "required": ["value"],
+        "title": "URL of external resource",
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    }
+  }
+}

invenio_app_ils/eitems/search.py

@@ -31,9 +31,7 @@ class EItemSearch(RecordsSearch):
         if document_pid:
             search = search.filter("term", document_pid=document_pid)
         else:
-            raise MissingRequiredParameterError(
-                description="document_pid is required"
-            )
+            raise MissingRequiredParameterError(description="document_pid is required")
 
         if filter_states:
             search = search.filter("terms", status=filter_states)
@@ -49,16 +47,12 @@ class EItemSearch(RecordsSearch):
         if bucket_id:
             search = search.filter("term", bucket_id=bucket_id)
         else:
-            raise MissingRequiredParameterError(
-                description="bucket_id is required"
-            )
+            raise MissingRequiredParameterError(description="bucket_id is required")
 
         results = search.execute()
         if len(results) != 1:
             # There should always be one bucket associated with an eitem when
             # downloading a file.
-            msg = "found 0 or multiple records with bucket {0}".format(
-                bucket_id
-            )
+            msg = "found 0 or multiple records with bucket {0}".format(bucket_id)
             current_app.logger.warning(msg)
         return results

invenio_app_ils/errors.py

@@ -27,7 +27,7 @@ class IlsException(RESTException):
         """The status name."""
         return type(self).__name__
 
-    def get_body(self, environ=None):
+    def get_body(self, environ=None, scope=None):
         """Get the request body."""
         body = dict(
             status=self.code,
@@ -95,14 +95,20 @@ class RecordHasReferencesError(IlsException):
             ref_type=ref_type,
             ref_ids=ref_ids,
         )
+        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}'"
@@ -180,9 +191,68 @@ class PatronHasLoanOnDocumentError(IlsException):
         )
 
 
+class LoanCheckoutByPatronForbidden(IlsException):
+    """A patron cannot checkout an item for another patron."""
+
+    code = 403
+    description = "Forbidden. Patron '{current_user_pid}' cannot checkout item for another Patron '{patron_pid}'."
+
+    def __init__(self, patron_pid, current_user_pid, **kwargs):
+        """Initialize LoanCheckoutByPatronForbidden exception."""
+        super().__init__(**kwargs)
+        self.description = self.description.format(
+            patron_pid=patron_pid, current_user_pid=current_user_pid
+        )
+
+
+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"
@@ -197,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."""
@@ -213,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."""
@@ -227,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."""
@@ -238,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):
@@ -279,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."""