Update main with local changes and upstream

.github/workflows/dependencies.yml

@@ -0,0 +1,41 @@
+name: update dependencies
+on:
+
+  schedule:
+    - cron:  '0 0 1 * *'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: development
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          cache: pip
+
+      - name: Install pre-commit and pip-tools
+        run: pip install pre-commit pip-tools
+
+      - name: Run pre-commit autoupdate
+        run: pre-commit autoupdate
+
+      - name: Run pip-compile
+        run: pip-compile --upgrade
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          base: development
+          branch: dependency-updates
+          delete-branch: true
+          title: Dependency Updates
+          commit-message: Dependency updates

.pre-commit-config.yaml

@@ -1,20 +1,20 @@
 repos:
 - repo: https://github.com/pre-commit/mirrors-autopep8
-  rev: v1.6.0
+  rev: v2.0.1
   hooks:
   - id: autopep8
     args:
       - --in-place
       - --aggressive
 - repo: https://github.com/pycqa/flake8
-  rev: 4.0.1
+  rev: 6.0.0
   hooks:
   - id: flake8
 - repo: https://github.com/pycqa/isort
-  rev: 5.10.1
+  rev: 5.11.4
   hooks:
   - id: isort
 - repo: https://github.com/jazzband/pip-tools
-  rev: 6.5.1
+  rev: 6.12.1
   hooks:
     - id: pip-compile

Dockerfile

@@ -1,11 +1,6 @@
-FROM python:3.10-buster
+FROM python:3.10
 
 ENV PYTHONUNBUFFERED 1
-RUN apt-get update \
-    && apt-get install -y \
-      postgresql \
-    && rm -rf /var/lib/apt/lists/*
-
 WORKDIR /code
 ADD requirements.txt /code/
 RUN pip install --upgrade pip && pip install --no-cache-dir -r requirements.txt

docker-compose.yml

@@ -2,7 +2,7 @@ version: '3'
 
 services:
   request-broker-db:
-    image: postgres:10.4
+    image: postgres:14.4
     environment:
       - POSTGRES_USER=postgres  # name of the application database user
       - POSTGRES_PASSWORD=postgres  # name of the application database user

fixtures/as_data.json

@@ -1,4 +1,5 @@
 {
+    "ead_id": "",
     "creators": "Ford Foundation",
     "collection_name": "Ford Foundation records, General Correspondence",
     "parent": "General Correspondence",
@@ -18,5 +19,6 @@
     "title": "Adler, Mortimer J.",
     "restrictions": "closed",
     "restrictions_text": "Closed until further notice due to personally identifying information.",
+    "restricted_in_container": null,
     "uri": "/repositories/2/archival_objects/986296"
 }

fixtures/locations.json

@@ -5,6 +5,7 @@
     "container_locations": [
         {
             "_resolved": {
+                "building": "Rockefeller Archive Center",
                 "title": "Rockefeller Archive Center, Blue Level, Vault 106 [Unit:  66, Shelf:  7]",
                 "room": "Vault 106",
                 "coordinate_1_indicator": "66",

fixtures/locations_offsite.json

@@ -0,0 +1,16 @@
+{
+    "type": "box",
+    "indicator": "2",
+    "barcode": "A12345",
+    "container_locations": [
+        {
+            "_resolved": {
+                "building": "Armonk",
+                "title": "Armonk, Vault 1 [Unit:  66, Shelf:  7]",
+                "room": "Vault 1",
+                "coordinate_1_indicator": "66",
+                "coordinate_2_indicator": "7"
+            }
+        }
+    ]
+}

process_request/helpers.py

@@ -1,8 +1,11 @@
+import json
 import re
 
 import inflect
 import shortuuid
-from asnake.utils import get_date_display, get_note_text, text_in_note
+from asnake.utils import (format_resource_id, get_date_display, get_note_text,
+                          text_in_note)
+from django.conf import settings
 from ordered_set import OrderedSet
 
 CONFIDENCE_RATIO = 97  # Minimum confidence ratio to match against.
@@ -50,6 +53,8 @@ def get_file_versions(digital_object):
 def get_locations(top_container_info):
     """Gets a string representation of a location for an ArchivesSpace top container.
 
+    Adds the building name for offsite locations only.
+
     Args:
         top_container_info (dict): json for a top container (with resolved container locations)
 
@@ -58,10 +63,12 @@ def get_locations(top_container_info):
     """
 
     def make_short_location(loc_data):
-        return ".".join([
-            loc_data.get("room", "").strip().replace("Vault ", ""),
-            loc_data.get("coordinate_1_indicator", "").strip(),
-            loc_data.get("coordinate_2_indicator", "").strip()])
+        location_list = [loc_data.get("room", "").strip().replace("Vault ", ""),
+                         loc_data.get("coordinate_1_indicator", "").strip(),
+                         loc_data.get("coordinate_2_indicator", "").strip()]
+        if loc_data.get("building") in settings.OFFSITE_BUILDINGS:
+            location_list.insert(0, loc_data["building"])
+        return ".".join(location_list)
 
     locations = None
     if top_container_info.get("container_locations"):
@@ -154,6 +161,43 @@ def get_preferred_format(item_json):
     return preferred
 
 
+def get_restricted_in_container(container_uri, client):
+    """Fetches information about other restricted items in the same container.
+
+    Args:
+        container_uri (string): A URI for an ArchivesSpace Top Container.
+
+    Returns:
+        restricted (string): a comma-separated list of other restricted items in
+            the same container.
+    """
+    restricted = []
+    this_page = 1
+    more = True
+    while more:
+        escaped_url = container_uri.replace('/', '\\/')
+        search_uri = f"repositories/{settings.ARCHIVESSPACE['repo_id']}/search?q=top_container_uri_u_sstr:{escaped_url}&page={this_page}&fields[]=uri,json,ancestors&resolve[]=ancestors:id&type[]=archival_object&page_size=25"
+        items_in_container = client.get(search_uri).json()
+        for item in items_in_container["results"]:
+            item_json = json.loads(item["json"])
+            status = get_rights_status(item_json, client)
+            if not status:
+                for ancestor_uri in item["_resolved_ancestors"]:
+                    for ancestor in item["_resolved_ancestors"][ancestor_uri]:
+                        status = get_rights_status(json.loads(ancestor["json"]), client)
+                        if status:
+                            break
+            if status in ["closed", "conditional"]:
+                for instance in item_json["instances"]:
+                    sub_container = instance.get("sub_container", [])
+                    if all(["type_2" in sub_container, "indicator_2" in sub_container]):
+                        restricted.append(f"{sub_container['type_2'].capitalize()} {sub_container['indicator_2']}")
+        this_page += 1
+        if this_page > items_in_container["last_page"]:
+            more = False
+    return ", ".join(restricted)
+
+
 def get_rights_info(item_json, client):
     """Gets rights status and text for an archival object.
 
@@ -238,7 +282,7 @@ def get_rights_text(item_json, client):
     return text
 
 
-def get_resource_creators(resource):
+def get_resource_creators(resource, client):
     """Gets all creators of a resource record and concatenate them into a string
     separated by commas.
 
@@ -250,10 +294,12 @@ def get_resource_creators(resource):
     """
     creators = []
     if resource.get("linked_agents"):
-        for linked_agent in resource.get("linked_agents"):
-            if linked_agent.get("role") == "creator":
-                creators.append(linked_agent.get("_resolved").get('display_name').get('sort_name'))
-    return ", ".join(creators)
+        linked_agent_uris = [a["ref"].replace("/", "\\/") for a in resource["linked_agents"] if a["role"] == "creator"]
+        search_uri = f"/repositories/{settings.ARCHIVESSPACE['repo_id']}/search?fields[]=title&type[]=agent_person&type[]=agent_corporate_entity&type[]=agent_family&page=1&q={' OR '.join(linked_agent_uris)}"
+        resp = client.get(search_uri)
+        resp.raise_for_status()
+        creators = resp.json()["results"]
+    return ", ".join([a["title"] for a in creators])
 
 
 def get_dates(archival_object, client):
@@ -329,10 +375,11 @@ def get_parent_title(obj_json):
     return title
 
 
-def get_url(obj_json, host, client):
-    """Returns a full URL for an object."""
+def get_url(obj_json, client, host=None):
+    """Returns a full or relative URL for an object, depending on if a host is provided."""
     uuid = shortuuid.uuid(name=obj_json["uri"])
-    return "{}/collections/{}".format(host, uuid) if has_children(obj_json, client) else "{}/objects/{}".format(host, uuid)
+    path = "collections" if has_children(obj_json, client) else "objects"
+    return f"{host}/{path}/{uuid}" if host else f"/{path}/{uuid}"
 
 
 def has_children(obj_json, client):
@@ -366,3 +413,21 @@ def list_chunks(lst, n):
     """
     for i in range(0, len(lst), n):
         yield lst[i:i + n]
+
+
+def resolve_ref_id(repo_id, ref_id, client):
+    """ Accepts options to find archival objects using find_by_id method.
+
+    Generates and returns a DIMES URI from an ArchiveSpace URI.
+    """
+    aspace_objs = client.get('/repositories/{}/find_by_id/archival_objects?ref_id[]={}&resolve[]=archival_objects'.format(repo_id, ref_id)).json()
+    aspace_obj = aspace_objs['archival_objects'][0]['_resolved']
+    return get_url(aspace_obj, client)
+
+
+def get_formatted_resource_id(resource, client):
+    """Gets a formatted resource id from the resource
+
+    Concatenates the resource id parts using the separator from the config
+    """
+    return format_resource_id(resource, client, settings.RESOURCE_ID_SEPARATOR)