folio-data-import 0.2.6__py3-none-any.whl → 0.2.8rc1__py3-none-any.whl

folio_data_import/UserImport.py

@@ -5,6 +5,7 @@ import getpass
 import json
 import os
 import time
+import uuid
 from datetime import datetime as dt
 from pathlib import Path
 from typing import Tuple
@@ -41,12 +42,12 @@ class UserImporter:  # noqa: R0902
         self,
         folio_client: folioclient.FolioClient,
         library_name: str,
-        user_file_path: Path,
         batch_size: int,
         limit_simultaneous_requests: asyncio.Semaphore,
         logfile: AsyncTextIOWrapper,
         errorfile: AsyncTextIOWrapper,
         http_client: httpx.AsyncClient,
+        user_file_path: Path = None,
         user_match_key: str = "externalSystemId",
         only_update_present_fields: bool = False,
         default_preferred_contact_type: str = "002",
@@ -94,14 +95,34 @@ class UserImporter:  # noqa: R0902
         """
         return {x[name]: x["id"] for x in folio_client.folio_get_all(endpoint, key)}
 
+    @staticmethod
+    def validate_uuid(uuid_string: str) -> bool:
+        """
+        Validate a UUID string.
+
+        Args:
+            uuid_string (str): The UUID string to validate.
+
+        Returns:
+            bool: True if the UUID is valid, otherwise False.
+        """
+        try:
+            uuid.UUID(uuid_string)
+            return True
+        except ValueError:
+            return False
+
     async def do_import(self) -> None:
         """
         Main method to import users.
 
         This method triggers the process of importing users by calling the `process_file` method.
         """
-        with open(self.user_file_path, "r", encoding="utf-8") as openfile:
-            await self.process_file(openfile)
+        if self.user_file_path:
+            with open(self.user_file_path, "r", encoding="utf-8") as openfile:
+                await self.process_file(openfile)
+        else:
+            raise FileNotFoundError("No user objects file provided")
 
     async def get_existing_user(self, user_obj) -> dict:
         """
@@ -200,10 +221,20 @@ class UserImporter:  # noqa: R0902
             mapped_addresses = []
             for address in addresses:
                 try:
-                    address["addressTypeId"] = self.address_type_map[
-                        address["addressTypeId"]
-                    ]
-                    mapped_addresses.append(address)
+                    if (
+                        self.validate_uuid(address["addressTypeId"])
+                        and address["addressTypeId"] in self.address_type_map.values()
+                    ):
+                        await self.logfile.write(
+                            f"Row {line_number}: Address type {address['addressTypeId']} is a UUID, "
+                            f"skipping mapping\n"
+                        )
+                        mapped_addresses.append(address)
+                    else:
+                        address["addressTypeId"] = self.address_type_map[
+                            address["addressTypeId"]
+                        ]
+                        mapped_addresses.append(address)
                 except KeyError:
                     if address["addressTypeId"] not in self.address_type_map.values():
                         print(
@@ -229,7 +260,16 @@ class UserImporter:  # noqa: R0902
             None
         """
         try:
-            user_obj["patronGroup"] = self.patron_group_map[user_obj["patronGroup"]]
+            if (
+                self.validate_uuid(user_obj["patronGroup"])
+                and user_obj["patronGroup"] in self.patron_group_map.values()
+            ):
+                await self.logfile.write(
+                    f"Row {line_number}: Patron group {user_obj['patronGroup']} is a UUID, "
+                    f"skipping mapping\n"
+                )
+            else:
+                user_obj["patronGroup"] = self.patron_group_map[user_obj["patronGroup"]]
         except KeyError:
             if user_obj["patronGroup"] not in self.patron_group_map.values():
                 print(
@@ -256,7 +296,16 @@ class UserImporter:  # noqa: R0902
         mapped_departments = []
         for department in user_obj.pop("departments", []):
             try:
-                mapped_departments.append(self.department_map[department])
+                if (
+                    self.validate_uuid(department)
+                    and department in self.department_map.values()
+                ):
+                    await self.logfile.write(
+                        f"Row {line_number}: Department {department} is a UUID, skipping mapping\n"
+                    )
+                    mapped_departments.append(department)
+                else:
+                    mapped_departments.append(self.department_map[department])
             except KeyError:
                 print(
                     f'Row {line_number}: Department "{department}" not found, '  # noqa: B907
@@ -674,7 +723,13 @@ class UserImporter:  # noqa: R0902
             mapped_service_points = []
             for sp in spu_obj.pop("servicePointsIds", []):
                 try:
-                    mapped_service_points.append(self.service_point_map[sp])
+                    if self.validate_uuid(sp) and sp in self.service_point_map.values():
+                        await self.logfile.write(
+                            f"Service point {sp} is a UUID, skipping mapping\n"
+                        )
+                        mapped_service_points.append(sp)
+                    else:
+                        mapped_service_points.append(self.service_point_map[sp])
                 except KeyError:
                     print(
                         f'Service point "{sp}" not found, excluding service point from user: '
@@ -685,7 +740,13 @@ class UserImporter:  # noqa: R0902
         if "defaultServicePointId" in spu_obj:
             sp_code = spu_obj.pop('defaultServicePointId', '')
             try:
-                mapped_sp_id = self.service_point_map[sp_code]
+                if self.validate_uuid(sp_code) and sp_code in self.service_point_map.values():
+                    await self.logfile.write(
+                        f"Default service point {sp_code} is a UUID, skipping mapping\n"
+                    )
+                    mapped_sp_id = sp_code
+                else:
+                    mapped_sp_id = self.service_point_map[sp_code]
                 if mapped_sp_id not in spu_obj.get('servicePointsIds', []):
                     print(
                         f'Default service point "{sp_code}" not found in assigned service points, '
@@ -781,7 +842,7 @@ class UserImporter:  # noqa: R0902
         Process the user object file.
 
         Args:
-            openfile: The file object to process.
+            openfile: The file or file-like object to process.
         """
         tasks = []
         for line_number, user in enumerate(openfile):
@@ -935,12 +996,12 @@ async def main() -> None:
             importer = UserImporter(
                 folio_client,
                 library_name,
-                user_file_path,
                 batch_size,
                 limit_async_requests,
                 logfile,
                 errorfile,
                 http_client,
+                user_file_path,
                 args.user_match_key,
                 args.update_only_present_fields,
                 args.default_preferred_contact_type,

{folio_data_import-0.2.6.dist-info → folio_data_import-0.2.8rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: folio_data_import
-Version: 0.2.6
+Version: 0.2.8rc1
 Summary: A python module to interact with the data importing capabilities of the open-source FOLIO ILS
 License: MIT
 Author: Brooks Travis
@@ -102,11 +102,30 @@ When this package is installed via PyPI or using `poetry install` from this repo
     }
 }
 ```
-One thing to note here is that this importer does not require `externalSystemId` as the match point for your objects. While it is the default, if the user objects have `id` present, that will be used, falling back to `externalSystemId`. However, you can also specify `username` or `barcode` as the match point if desired, using the `--default_preferred_contact_type` argument.
+#### Matching Existing Users
 
-Another point of departure from the behavior of `mod-user-import` is the handling of `preferredContactTypeId`. This importer will accept either the `"001", "002", "003"...` values stored by the FOLIO, or the human-friendly strings used by `mod-user-import` (`"mail", "email", "text", "phone", "mobile"`). It will also __*set a customizable default for all users that do not otherwise have a valid value specified*__, unless a value is already present in the user record being updated.
+Unlike mod-user-import, this importer does not require `externalSystemId` as the match point for your objects. If the user objects have `id` values, that will be used, falling back to `externalSystemId`. However, you can also specify `username` or `barcode` as the match point if desired, using the `--user_match_key` argument.
 
-How to use:
+#### Preferred Contact Type Mapping
+
+Another point of departure from the behavior of `mod-user-import` is the handling of `preferredContactTypeId`. This importer will accept either the `"001", "002", "003"...` values stored by the FOLIO, or the human-friendly strings used by `mod-user-import` (`"mail", "email", "text", "phone", "mobile"`). It will also __*set a customizable default for all users that do not otherwise have a valid value specified*__ (using `--default_preferred_contact_type`), unless a (valid) value is already present in the user record being updated.
+
+#### Field Protection (*experimental*)
+
+This script offers a rudimentary field protection implementation using custom fields. To enable this functionality, create a text custom field that has the field name `protectedFields`. In this field, you ca specify a comma-separated list of User schema field names, using dot-notation for nested fields. This protection should support all standard fields except addresses within `personal.addresses`. If you include `personal.addresses` in a user record, any existing addresses will be replaced by the new values.
+
+##### Example
+
+```
+{
+    "protectedFields": "customFields.protectedFields,personal.preferredFirstName,barcode,personal.telephone,personal.addresses"
+}
+```
+
+Would result in `preferredFirstName`, `barcode`, and `telephone` remaining unchanged, regardless of the contents of the incoming records.
+
+
+#### How to use:
 1. Generate a JSON lines (one JSON object per line) file of FOLIO user objects in the style of [mod-user-import](https://github.com/folio-org/mod-user-import)
 2. Run the script and specify the required arguments (and any desired optional arguments), including the path to your file of user objects
 

folio_data_import-0.2.8rc1.dist-info/RECORD

@@ -0,0 +1,11 @@
+folio_data_import/MARCDataImport.py,sha256=gFBq6DwghC3hXPkkM-c0XlPjtoZwITVAeEhH8joPIQo,23450
+folio_data_import/UserImport.py,sha256=zs0kts3dCY2L0ZdMgtsbT0xrTXabvP3wxd9B75FcWF8,40984
+folio_data_import/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+folio_data_import/__main__.py,sha256=kav_uUsnrIjGjVxQkk3exLKrc1mah9t2x3G6bGS-5I0,3710
+folio_data_import/marc_preprocessors/__init__.py,sha256=Wt-TKkMhUyZWFS-WhAmbShKQLPjXmHKPb2vL6kvkqVA,72
+folio_data_import/marc_preprocessors/_preprocessors.py,sha256=srx36pgY0cwl6_0z6CVOyM_Uzr_g2RObo1jJJjSEZJs,944
+folio_data_import-0.2.8rc1.dist-info/LICENSE,sha256=qJX7wxMC7ky9Kq4v3zij8MjGEiC5wsB7pYeOhLj5TDk,1083
+folio_data_import-0.2.8rc1.dist-info/METADATA,sha256=ofqGY2Z0W50cu5kZTkvLp6IRB2NyBsVyPSkmBA6yf3k,6115
+folio_data_import-0.2.8rc1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+folio_data_import-0.2.8rc1.dist-info/entry_points.txt,sha256=498SxWVXeEMRNw3PUf-eoReZvKewmYwPBtZhIUPr_Jg,192
+folio_data_import-0.2.8rc1.dist-info/RECORD,,

folio_data_import-0.2.6.dist-info/RECORD

@@ -1,11 +0,0 @@
-folio_data_import/MARCDataImport.py,sha256=gFBq6DwghC3hXPkkM-c0XlPjtoZwITVAeEhH8joPIQo,23450
-folio_data_import/UserImport.py,sha256=2sTEJVZDVw9rS833LdanbMA_-EPkd8MqYlbznqUvlaQ,38445
-folio_data_import/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-folio_data_import/__main__.py,sha256=kav_uUsnrIjGjVxQkk3exLKrc1mah9t2x3G6bGS-5I0,3710
-folio_data_import/marc_preprocessors/__init__.py,sha256=Wt-TKkMhUyZWFS-WhAmbShKQLPjXmHKPb2vL6kvkqVA,72
-folio_data_import/marc_preprocessors/_preprocessors.py,sha256=srx36pgY0cwl6_0z6CVOyM_Uzr_g2RObo1jJJjSEZJs,944
-folio_data_import-0.2.6.dist-info/LICENSE,sha256=qJX7wxMC7ky9Kq4v3zij8MjGEiC5wsB7pYeOhLj5TDk,1083
-folio_data_import-0.2.6.dist-info/METADATA,sha256=4WvmabtkdQEOPlw9z6ZuTh_KCTImcFPF7GgZYG_3_6g,5186
-folio_data_import-0.2.6.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-folio_data_import-0.2.6.dist-info/entry_points.txt,sha256=498SxWVXeEMRNw3PUf-eoReZvKewmYwPBtZhIUPr_Jg,192
-folio_data_import-0.2.6.dist-info/RECORD,,