internal location: add field accessible_by_patrons

JakobMiesner · JakobMiesner · commit 5f4818e98971 · 2025-06-25T17:39:15.000+02:00
diff --git a/invenio_app_ils/cli.py b/invenio_app_ils/cli.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.
@@ -202,6 +202,7 @@ def generate(self):
                 "notes": lorem.sentence(),
                 "physical_location": lorem.sentence(),
                 "location_pid": location_pid_value,
+                "accessible_by_patrons": True,
             }
             for pid in range(1, size + 1)
         ]
diff --git a/invenio_app_ils/documents/jsonresolvers/document_item.py b/invenio_app_ils/documents/jsonresolvers/document_item.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2019-2020 CERN.
+# Copyright (C) 2019-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.
@@ -40,6 +40,9 @@ def items_resolver(document_pid):
                 "identifiers": item.get("identifiers"),
                 "internal_location": {
                     "name": item.get("internal_location", {}).get("name", ""),
+                    "accessible_by_patrons": item.get("internal_location", {}).get(
+                        "accessible_by_patrons", True
+                    ),
                     "location": {
                         "name": (
                             item.get("internal_location", {})
diff --git a/invenio_app_ils/documents/mappings/os-v1/documents/document-v1.0.0.json b/invenio_app_ils/documents/mappings/os-v1/documents/document-v1.0.0.json
@@ -407,6 +407,9 @@
                   },
                   "name": {
                     "type": "keyword"
+                  },
+                  "accessible_by_patrons": {
+                    "type": "boolean"
                   }
                 },
                 "type": "object"
diff --git a/invenio_app_ils/documents/mappings/os-v1/documents/document-v2.0.0.json b/invenio_app_ils/documents/mappings/os-v1/documents/document-v2.0.0.json
@@ -492,6 +492,9 @@
                   },
                   "name": {
                     "type": "keyword"
+                  },
+                  "accessible_by_patrons": {
+                    "type": "boolean"
                   }
                 },
                 "type": "object"
diff --git a/invenio_app_ils/documents/mappings/os-v2/documents/document-v1.0.0.json b/invenio_app_ils/documents/mappings/os-v2/documents/document-v1.0.0.json
@@ -407,6 +407,9 @@
                   },
                   "name": {
                     "type": "keyword"
+                  },
+                  "accessible_by_patrons": {
+                    "type": "boolean"
                   }
                 },
                 "type": "object"
diff --git a/invenio_app_ils/documents/mappings/os-v2/documents/document-v2.0.0.json b/invenio_app_ils/documents/mappings/os-v2/documents/document-v2.0.0.json
@@ -492,6 +492,9 @@
                   },
                   "name": {
                     "type": "keyword"
+                  },
+                  "accessible_by_patrons": {
+                    "type": "boolean"
                   }
                 },
                 "type": "object"
diff --git a/invenio_app_ils/documents/mappings/v7/documents/document-v1.0.0.json b/invenio_app_ils/documents/mappings/v7/documents/document-v1.0.0.json
@@ -407,6 +407,9 @@
                   },
                   "name": {
                     "type": "keyword"
+                  },
+                  "accessible_by_patrons": {
+                    "type": "boolean"
                   }
                 },
                 "type": "object"
diff --git a/invenio_app_ils/documents/mappings/v7/documents/document-v2.0.0.json b/invenio_app_ils/documents/mappings/v7/documents/document-v2.0.0.json
@@ -492,6 +492,9 @@
                   },
                   "name": {
                     "type": "keyword"
+                  },
+                  "accessible_by_patrons": {
+                    "type": "boolean"
                   }
                 },
                 "type": "object"
diff --git a/invenio_app_ils/internal_locations/loaders/jsonschemas/internal_location.py b/invenio_app_ils/internal_locations/loaders/jsonschemas/internal_location.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2018 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.
@@ -24,3 +24,4 @@ class Meta:
     legacy_ids = fields.List(fields.Str())
     notes = fields.Str()
     physical_location = fields.Str()
+    accessible_by_patrons = fields.Boolean(required=True)
diff --git a/invenio_app_ils/internal_locations/mappings/os-v1/internal_locations/internal_location-v1.0.0.json b/invenio_app_ils/internal_locations/mappings/os-v1/internal_locations/internal_location-v1.0.0.json
@@ -102,6 +102,9 @@
       },
       "pid": {
         "type": "keyword"
+      },
+      "accessible_by_patrons": {
+        "type": "boolean"
       }
     }
   }
diff --git a/invenio_app_ils/internal_locations/mappings/os-v2/internal_locations/internal_location-v1.0.0.json b/invenio_app_ils/internal_locations/mappings/os-v2/internal_locations/internal_location-v1.0.0.json
@@ -102,6 +102,9 @@
       },
       "pid": {
         "type": "keyword"
+      },
+      "accessible_by_patrons": {
+        "type": "boolean"
       }
     }
   }
diff --git a/invenio_app_ils/internal_locations/mappings/v7/internal_locations/internal_location-v1.0.0.json b/invenio_app_ils/internal_locations/mappings/v7/internal_locations/internal_location-v1.0.0.json
@@ -102,6 +102,9 @@
       },
       "pid": {
         "type": "keyword"
+      },
+      "accessible_by_patrons": {
+        "type": "boolean"
       }
     }
   }
diff --git a/invenio_app_ils/internal_locations/schemas/internal_locations/internal_location-v1.0.0.json b/invenio_app_ils/internal_locations/schemas/internal_locations/internal_location-v1.0.0.json
@@ -2,7 +2,14 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Schema for Internal Location",
   "type": "object",
-  "required": ["$schema", "pid", "location", "location_pid", "name"],
+  "required": [
+    "$schema",
+    "pid",
+    "location",
+    "location_pid",
+    "name",
+    "accessible_by_patrons"
+  ],
   "properties": {
     "$schema": {
       "type": "string"
@@ -41,6 +48,10 @@
     "pid": {
       "type": "string",
       "title": "The persistent identifier of this Internal Location"
+    },
+    "accessible_by_patrons": {
+      "type": "boolean",
+      "title": "Marks if this Internal Location is accessible by patrons"
     }
   }
 }
diff --git a/invenio_app_ils/items/mappings/os-v1/items/item-v1.0.0.json b/invenio_app_ils/items/mappings/os-v1/items/item-v1.0.0.json
@@ -149,6 +149,9 @@
           "legacy_id": {
             "type": "keyword"
           },
+          "accessible_by_patrons": {
+            "type": "boolean"
+          },
           "location": {
             "properties": {
               "pid": {
diff --git a/invenio_app_ils/items/mappings/os-v1/items/item-v2.0.0.json b/invenio_app_ils/items/mappings/os-v1/items/item-v2.0.0.json
@@ -190,6 +190,9 @@
           "legacy_id": {
             "type": "keyword"
           },
+          "accessible_by_patrons": {
+            "type": "boolean"
+          },
           "location": {
             "properties": {
               "pid": {
diff --git a/invenio_app_ils/items/mappings/os-v2/items/item-v1.0.0.json b/invenio_app_ils/items/mappings/os-v2/items/item-v1.0.0.json
@@ -149,6 +149,9 @@
           "legacy_id": {
             "type": "keyword"
           },
+          "accessible_by_patrons": {
+            "type": "boolean"
+          },
           "location": {
             "properties": {
               "pid": {
diff --git a/invenio_app_ils/items/mappings/os-v2/items/item-v2.0.0.json b/invenio_app_ils/items/mappings/os-v2/items/item-v2.0.0.json
@@ -190,6 +190,9 @@
           "legacy_id": {
             "type": "keyword"
           },
+          "accessible_by_patrons": {
+            "type": "boolean"
+          },
           "location": {
             "properties": {
               "pid": {
diff --git a/invenio_app_ils/items/mappings/v7/items/item-v1.0.0.json b/invenio_app_ils/items/mappings/v7/items/item-v1.0.0.json
@@ -216,6 +216,9 @@
           },
           "pid": {
             "type": "keyword"
+          },
+          "accessible_by_patrons": {
+            "type": "boolean"
           }
         },
         "type": "object"
diff --git a/invenio_app_ils/items/mappings/v7/items/item-v2.0.0.json b/invenio_app_ils/items/mappings/v7/items/item-v2.0.0.json
@@ -190,6 +190,9 @@
           "legacy_id": {
             "type": "keyword"
           },
+          "accessible_by_patrons": {
+            "type": "boolean"
+          },
           "location": {
             "properties": {
               "pid": {
diff --git a/tests/api/ils/documents/test_document_resolvers.py b/tests/api/ils/documents/test_document_resolvers.py
@@ -26,10 +26,16 @@ def test_document_resolvers(app, testdata):
     assert "past_loans_count" in document["circulation"]
 
     # item and eitems
-    assert document["items"]["total"] == 9 and document["items"]["hits"]
+    assert document["items"]["total"] == 10 and document["items"]["hits"]
     assert document["eitems"]["total"] == 3 and document["eitems"]["hits"]
 
     # stock
     mediums = set([item["medium"] for item in document["items"]["hits"]])
     mediums.add("E-BOOK")
     assert set(document["stock"]["mediums"]) == mediums
+
+    # internal location - accessible_by_patrons
+    item = next(
+        item for item in document["items"]["hits"] if item["pid"] == "itemid-75"
+    )
+    assert item["internal_location"]["accessible_by_patrons"] is False
diff --git a/tests/api/ils/items/test_apis.py b/tests/api/ils/items/test_apis.py
@@ -19,7 +19,7 @@ def test_get_item_pids_by_document_pid(testdata):
     """Test retrieve Items PIDs for the given Document PID."""
     first_doc_pid = testdata["documents"][0]["pid"]
     items_pids = get_item_pids_by_document_pid(first_doc_pid)
-    assert len(list(items_pids)) == 9
+    assert len(list(items_pids)) == 10
 
 
 def test_get_document_pid_by_item_pid(testdata):
diff --git a/tests/api/ils/test_internal_locations.py b/tests/api/ils/test_internal_locations.py
@@ -38,6 +38,7 @@ def test_internal_locations_permissions(client, testdata, json_headers, users):
     dummy_internal_location = dict(
         location_pid=testdata["locations"][0]["pid"],
         name=_INTERNAL_LOCATION_NAME,
+        accessible_by_patrons=True,
     )
     tests = [
         ("admin", _HTTP_OK, dummy_internal_location),
diff --git a/tests/api/ils/test_loaders.py b/tests/api/ils/test_loaders.py
@@ -18,6 +18,7 @@
     "legacy_ids": ["Test legacy id"],
     "name": "My test internal location",
     "physical_location": "Left from the right building",
+    "accessible_by_patrons": True,
     "notes": "In house",
 }
 
diff --git a/tests/data/internal_locations.json b/tests/data/internal_locations.json
@@ -2,21 +2,31 @@
   {
     "pid": "ilocid-1",
     "location_pid": "locid-1",
-    "name": "Internal Library 1"
+    "name": "Internal Library 1",
+    "accessible_by_patrons": true
   },
   {
     "pid": "ilocid-2",
     "location_pid": "locid-1",
-    "name": "Internal Library 2"
+    "name": "Internal Library 2",
+    "accessible_by_patrons": true
   },
   {
     "pid": "ilocid-3",
     "location_pid": "locid-1",
-    "name": "Unused Internal Library"
+    "name": "Unused Internal Library",
+    "accessible_by_patrons": true
   },
   {
     "pid": "ilocid-4",
     "location_pid": "locid-2",
-    "name": "Another unused library"
+    "name": "Another unused library",
+    "accessible_by_patrons": true
+  },
+  {
+    "pid": "ilocid-5",
+    "location_pid": "locid-5",
+    "name": "Location not accessible by patrons",
+    "accessible_by_patrons": false
   }
-]
+]
diff --git a/tests/data/items.json b/tests/data/items.json
@@ -300,5 +300,16 @@
     "medium": "NOT_SPECIFIED",
     "status": "IN_BINDING",
     "document": {}
+  },
+  {
+    "pid": "itemid-75",
+    "created_by": { "type": "script", "value": "demo" },
+    "barcode": "123456789-75",
+    "document_pid": "docid-1",
+    "internal_location_pid": "ilocid-5",
+    "circulation_restriction": "NO_RESTRICTION",
+    "medium": "NOT_SPECIFIED",
+    "status": "IN_BINDING",
+    "document": {}
   }
 ]
diff --git a/tests/data/locations.json b/tests/data/locations.json
@@ -22,5 +22,11 @@
     "name": "Library of Testing",
     "opening_weekdays": [{"weekday": "monday", "is_open": true}, {"weekday": "tuesday", "is_open": true}, {"weekday": "wednesday", "is_open": true}, {"weekday": "thursday", "is_open": true}, {"weekday": "friday", "is_open": true}, {"weekday": "saturday", "is_open": false}, {"weekday": "sunday", "is_open": false}],
     "opening_exceptions": []
+  },
+  {
+    "pid": "locid-5",
+    "name": "Depot",
+    "opening_weekdays": [{"weekday": "monday", "is_open": false}, {"weekday": "tuesday", "is_open": false}, {"weekday": "wednesday", "is_open": false}, {"weekday": "thursday", "is_open": false}, {"weekday": "friday", "is_open": false}, {"weekday": "saturday", "is_open": false}, {"weekday": "sunday", "is_open": false}],
+    "opening_exceptions": []
   }
 ]

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`	`2`	`#`
`3`		`-# Copyright (C) 2018-2020 CERN.`
	`3`	`+# Copyright (C) 2018-2025 CERN.`
`4`	`4`	`#`
`5`	`5`	`# invenio-app-ils is free software; you can redistribute it and/or modify it`
`6`	`6`	`# under the terms of the MIT License; see LICENSE file for more details.`
`@@ -202,6 +202,7 @@ def generate(self):`
`202`	`202`	`"notes": lorem.sentence(),`
`203`	`203`	`"physical_location": lorem.sentence(),`
`204`	`204`	`"location_pid": location_pid_value,`
	`205`	`+ "accessible_by_patrons": True,`
`205`	`206`	`}`
`206`	`207`	`for pid in range(1, size + 1)`
`207`	`208`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`	`2`	`#`
`3`		`-# Copyright (C) 2018 CERN.`
	`3`	`+# Copyright (C) 2018-2025 CERN.`
`4`	`4`	`#`
`5`	`5`	`# invenio-app-ils is free software; you can redistribute it and/or modify it`
`6`	`6`	`# under the terms of the MIT License; see LICENSE file for more details.`
`@@ -24,3 +24,4 @@ class Meta:`
`24`	`24`	`legacy_ids = fields.List(fields.Str())`
`25`	`25`	`notes = fields.Str()`
`26`	`26`	`physical_location = fields.Str()`
	`27`	`+ accessible_by_patrons = fields.Boolean(required=True)`
Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,9 @@`
`102`	`102`	`},`
`103`	`103`	`"pid": {`
`104`	`104`	`"type": "keyword"`
	`105`	`+ },`
	`106`	`+ "accessible_by_patrons": {`
	`107`	`+ "type": "boolean"`
`105`	`108`	`}`
`106`	`109`	`}`
`107`	`110`	`}`