rara-tools 0.0.8__tar.gz → 0.0.9__tar.gz

{rara_tools-0.0.8/rara_tools.egg-info → rara_tools-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rara-tools
-Version: 0.0.8
+Version: 0.0.9
 Summary: Tools to support Kata's work.
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -28,25 +28,28 @@ Requires-Dist: pytest-order; extra == "testing"
 
 ---
 
-## ✨ Features  
+## ✨ Features
 
 - Elasticsearch index & document operations
 - S3 file management operations
 - Task reporting to Core API
+- Converting SIERRA API responses to Pymarc compatible JSON
+
 ---
 
-## ⚡ Quick Start  
+## ⚡ Quick Start
 
 Get started with `rara-tools` in just a few steps:
 
 1. **Install the Package**  
-   Ensure you're using Python 3.10 or above, then run:  
+   Ensure you're using Python 3.10 or above, then run:
+
    ```bash
    pip install rara-tools
    ```
 
 2. **Import and Use**  
-   Example usage to download a folder from S3:  
+   Example usage to download a folder from S3:
 
    ```python
    from rara_tools.s3 import S3Files
@@ -77,22 +80,25 @@ Follow the steps below to install the `rara-tools` package, either via `pip` or
    Create or activate a Python environment using Python **3.10** or above.
 
 2. **Install the Package**  
-   Run the following command:  
+    Run the following command:
+
    ```bash
    pip install rara-tools
    ```
-</details>
+
+   </details>
 
 ---
 
 ### Local Installation
 
-Follow these steps to install the `rara-tools` package locally:  
+Follow these steps to install the `rara-tools` package locally:
 
 <details><summary>Click to expand</summary>
 
 1. **Clone the Repository**  
-   Clone the repository and navigate into it:  
+   Clone the repository and navigate into it:
+
    ```bash
    git clone <repository-url>
    cd <repository-directory>
@@ -100,25 +106,29 @@ Follow these steps to install the `rara-tools` package locally:
 
 2. **Set Up Python Environment**  
    Create or activate a Python environment using Python 3.10 or above. E.g:
+
    ```bash
    conda create -n py310 python==3.10
    conda activate py310
    ```
 
 3. **Install Build Package**  
-   Install the `build` package to enable local builds:  
+   Install the `build` package to enable local builds:
+
    ```bash
    pip install build
    ```
 
 4. **Build the Package**  
-   Run the following command inside the repository:  
+   Run the following command inside the repository:
+
    ```bash
    python -m build
    ```
 
 5. **Install the Package**  
-   Install the built package locally:  
+   Install the built package locally:
+
    ```bash
    pip install .
    ```
@@ -131,13 +141,13 @@ Follow these steps to install the `rara-tools` package locally:
 
 Follow these steps to test the `rara-tools` package.
 
-
 ### How to Test
 
 <details><summary>Click to expand</summary>
 
 1. **Clone the Repository**  
-   Clone the repository and navigate into it:  
+   Clone the repository and navigate into it:
+
    ```bash
    git clone <repository-url>
    cd <repository-directory>
@@ -147,25 +157,29 @@ Follow these steps to test the `rara-tools` package.
    Create or activate a Python environment using Python 3.10 or above.
 
 3. **Install Build Package**  
-   Install the `build` package:  
+   Install the `build` package:
+
    ```bash
    pip install build
    ```
 
 4. **Build the Package**  
-   Build the package inside the repository:  
+   Build the package inside the repository:
+
    ```bash
    python -m build
    ```
 
 5. **Install with Testing Dependencies**  
-   Install the package along with its testing dependencies:  
+   Install the package along with its testing dependencies:
+
    ```bash
    pip install .[testing]
    ```
 
 6. **Run Tests**  
-   Run the test suite from the repository root:  
+   Run the test suite from the repository root:
+
    ```bash
    python -m pytest -v tests
    ```

{rara_tools-0.0.8 → rara_tools-0.0.9}/README.md

@@ -8,25 +8,28 @@
 
 ---
 
-## ✨ Features  
+## ✨ Features
 
 - Elasticsearch index & document operations
 - S3 file management operations
 - Task reporting to Core API
+- Converting SIERRA API responses to Pymarc compatible JSON
+
 ---
 
-## ⚡ Quick Start  
+## ⚡ Quick Start
 
 Get started with `rara-tools` in just a few steps:
 
 1. **Install the Package**  
-   Ensure you're using Python 3.10 or above, then run:  
+   Ensure you're using Python 3.10 or above, then run:
+
    ```bash
    pip install rara-tools
    ```
 
 2. **Import and Use**  
-   Example usage to download a folder from S3:  
+   Example usage to download a folder from S3:
 
    ```python
    from rara_tools.s3 import S3Files
@@ -57,22 +60,25 @@ Follow the steps below to install the `rara-tools` package, either via `pip` or
    Create or activate a Python environment using Python **3.10** or above.
 
 2. **Install the Package**  
-   Run the following command:  
+    Run the following command:
+
    ```bash
    pip install rara-tools
    ```
-</details>
+
+   </details>
 
 ---
 
 ### Local Installation
 
-Follow these steps to install the `rara-tools` package locally:  
+Follow these steps to install the `rara-tools` package locally:
 
 <details><summary>Click to expand</summary>
 
 1. **Clone the Repository**  
-   Clone the repository and navigate into it:  
+   Clone the repository and navigate into it:
+
    ```bash
    git clone <repository-url>
    cd <repository-directory>
@@ -80,25 +86,29 @@ Follow these steps to install the `rara-tools` package locally:
 
 2. **Set Up Python Environment**  
    Create or activate a Python environment using Python 3.10 or above. E.g:
+
    ```bash
    conda create -n py310 python==3.10
    conda activate py310
    ```
 
 3. **Install Build Package**  
-   Install the `build` package to enable local builds:  
+   Install the `build` package to enable local builds:
+
    ```bash
    pip install build
    ```
 
 4. **Build the Package**  
-   Run the following command inside the repository:  
+   Run the following command inside the repository:
+
    ```bash
    python -m build
    ```
 
 5. **Install the Package**  
-   Install the built package locally:  
+   Install the built package locally:
+
    ```bash
    pip install .
    ```
@@ -111,13 +121,13 @@ Follow these steps to install the `rara-tools` package locally:
 
 Follow these steps to test the `rara-tools` package.
 
-
 ### How to Test
 
 <details><summary>Click to expand</summary>
 
 1. **Clone the Repository**  
-   Clone the repository and navigate into it:  
+   Clone the repository and navigate into it:
+
    ```bash
    git clone <repository-url>
    cd <repository-directory>
@@ -127,25 +137,29 @@ Follow these steps to test the `rara-tools` package.
    Create or activate a Python environment using Python 3.10 or above.
 
 3. **Install Build Package**  
-   Install the `build` package:  
+   Install the `build` package:
+
    ```bash
    pip install build
    ```
 
 4. **Build the Package**  
-   Build the package inside the repository:  
+   Build the package inside the repository:
+
    ```bash
    python -m build
    ```
 
 5. **Install with Testing Dependencies**  
-   Install the package along with its testing dependencies:  
+   Install the package along with its testing dependencies:
+
    ```bash
    pip install .[testing]
    ```
 
 6. **Run Tests**  
-   Run the test suite from the repository root:  
+   Run the test suite from the repository root:
+
    ```bash
    python -m pytest -v tests
    ```

rara_tools-0.0.9/VERSION

@@ -0,0 +1 @@
+0.0.9

rara_tools-0.0.9/rara_tools/converters.py

@@ -0,0 +1,41 @@
+from .exceptions import SierraResponseConverterException
+
+
+class SierraResponseConverter:
+    """  Takes a JSON response from the Sierra API (https://tester.ester.ee/iii/sierra-api/swagger/index.html)
+    and converts it to MARC-in-JSON format.
+    
+    """
+    
+    def __init__(self, response: dict):
+        if not isinstance(response, dict):
+            raise SierraResponseConverterException("Please provide a valid JSON response.")
+        self.response = response
+        
+    def _map_field_data(self, field):
+        tag = field.get("tag")
+        if not tag:
+            raise SierraResponseConverterException("Field is missing a valid 'tag'.")
+        data = field.get("data", {})
+        return {tag: data}
+        
+    def _convert_response(self):
+        response = self.response
+        
+        entries = response.get("entries")
+        if not entries:
+            raise SierraResponseConverterException("No entries found in the response.")
+        
+        try:
+            fields = [self._map_field_data(f) for e in entries for f in e["marc"]["fields"]]
+        except KeyError as e:
+            raise SierraResponseConverterException(f"Missing expected MARC fields in the response: {e}")
+        
+        return {"fields": fields}
+            
+    def convert(self):
+        """Runner method, converts the response to MARC-in-JSON format with error handling."""
+        try:
+            return self._convert_response()
+        except Exception as e:
+            raise SierraResponseConverterException(f"An unexpected error occurred during conversion: {e}")

{rara_tools-0.0.8 → rara_tools-0.0.9}/rara_tools/decorators.py

@@ -1,12 +1,12 @@
 import functools
+from typing import Any, Callable
+
 from elasticsearch import AuthenticationException
 from elasticsearch import ConnectionError as ElasticsearchConnectionError
 from elasticsearch import ConnectionTimeout, NotFoundError, RequestError
-from typing import Any, Callable
 
 from .exceptions import ElasticsearchException
 
-
 ELASTIC_NOT_FOUND_MESSAGE = 'Could not find specified data from Elasticsearch!'
 ELASTIC_REQUEST_ERROR_MESSAGE = 'Error executing Elasticsearch query! Bad query?'
 ELASTIC_CONNECTION_TIMEOUT_MESSAGE = 'Connection to Elasticsearch took too long, please try again later!'
@@ -39,4 +39,4 @@ def _elastic_connection(func: Callable) -> Callable:
 			raise ElasticsearchException(ELASTIC_CONNECTION_ERROR_MESSAGE) from exception
 		except Exception as exception:
 			raise ElasticsearchException(ELASTIC_UNKNOWN_ERROR_MESSAGE) from exception
-	return wrapper
+	return wrapper

{rara_tools-0.0.8 → rara_tools-0.0.9}/rara_tools/elastic.py

@@ -1,4 +1,4 @@
-from typing import Dict, Optional, Any, Iterator
+from typing import Any, Dict, Iterator, Optional
 
 import elasticsearch_dsl
 from elastic_transport import ObjectApiResponse

{rara_tools-0.0.8 → rara_tools-0.0.9}/rara_tools/exceptions.py

@@ -12,3 +12,6 @@ class ElasticsearchException(Exception):
 
 class TaskReporterException(Exception):
     """Raised TaskReporter Error."""
+
+class SierraResponseConverterException(Exception):
+    """Raised SierraResponseConverter Error."""

{rara_tools-0.0.8 → rara_tools-0.0.9}/rara_tools/s3.py

@@ -1,10 +1,11 @@
 import os
 import uuid
-from typing import Optional, List, Generator, Any
+from typing import Any, Generator, List, Optional
 
 from minio import Minio
 
-from .exceptions import S3InitException, S3ConnectionException, S3InputException
+from .exceptions import (S3ConnectionException, S3InitException,
+                         S3InputException)
 
 
 class S3Files:

{rara_tools-0.0.8 → rara_tools-0.0.9/rara_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rara-tools
-Version: 0.0.8
+Version: 0.0.9
 Summary: Tools to support Kata's work.
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -28,25 +28,28 @@ Requires-Dist: pytest-order; extra == "testing"
 
 ---
 
-## ✨ Features  
+## ✨ Features
 
 - Elasticsearch index & document operations
 - S3 file management operations
 - Task reporting to Core API
+- Converting SIERRA API responses to Pymarc compatible JSON
+
 ---
 
-## ⚡ Quick Start  
+## ⚡ Quick Start
 
 Get started with `rara-tools` in just a few steps:
 
 1. **Install the Package**  
-   Ensure you're using Python 3.10 or above, then run:  
+   Ensure you're using Python 3.10 or above, then run:
+
    ```bash
    pip install rara-tools
    ```
 
 2. **Import and Use**  
-   Example usage to download a folder from S3:  
+   Example usage to download a folder from S3:
 
    ```python
    from rara_tools.s3 import S3Files
@@ -77,22 +80,25 @@ Follow the steps below to install the `rara-tools` package, either via `pip` or
    Create or activate a Python environment using Python **3.10** or above.
 
 2. **Install the Package**  
-   Run the following command:  
+    Run the following command:
+
    ```bash
    pip install rara-tools
    ```
-</details>
+
+   </details>
 
 ---
 
 ### Local Installation
 
-Follow these steps to install the `rara-tools` package locally:  
+Follow these steps to install the `rara-tools` package locally:
 
 <details><summary>Click to expand</summary>
 
 1. **Clone the Repository**  
-   Clone the repository and navigate into it:  
+   Clone the repository and navigate into it:
+
    ```bash
    git clone <repository-url>
    cd <repository-directory>
@@ -100,25 +106,29 @@ Follow these steps to install the `rara-tools` package locally:
 
 2. **Set Up Python Environment**  
    Create or activate a Python environment using Python 3.10 or above. E.g:
+
    ```bash
    conda create -n py310 python==3.10
    conda activate py310
    ```
 
 3. **Install Build Package**  
-   Install the `build` package to enable local builds:  
+   Install the `build` package to enable local builds:
+
    ```bash
    pip install build
    ```
 
 4. **Build the Package**  
-   Run the following command inside the repository:  
+   Run the following command inside the repository:
+
    ```bash
    python -m build
    ```
 
 5. **Install the Package**  
-   Install the built package locally:  
+   Install the built package locally:
+
    ```bash
    pip install .
    ```
@@ -131,13 +141,13 @@ Follow these steps to install the `rara-tools` package locally:
 
 Follow these steps to test the `rara-tools` package.
 
-
 ### How to Test
 
 <details><summary>Click to expand</summary>
 
 1. **Clone the Repository**  
-   Clone the repository and navigate into it:  
+   Clone the repository and navigate into it:
+
    ```bash
    git clone <repository-url>
    cd <repository-directory>
@@ -147,25 +157,29 @@ Follow these steps to test the `rara-tools` package.
    Create or activate a Python environment using Python 3.10 or above.
 
 3. **Install Build Package**  
-   Install the `build` package:  
+   Install the `build` package:
+
    ```bash
    pip install build
    ```
 
 4. **Build the Package**  
-   Build the package inside the repository:  
+   Build the package inside the repository:
+
    ```bash
    python -m build
    ```
 
 5. **Install with Testing Dependencies**  
-   Install the package along with its testing dependencies:  
+   Install the package along with its testing dependencies:
+
    ```bash
    pip install .[testing]
    ```
 
 6. **Run Tests**  
-   Run the test suite from the repository root:  
+   Run the test suite from the repository root:
+
    ```bash
    python -m pytest -v tests
    ```

{rara_tools-0.0.8 → rara_tools-0.0.9}/rara_tools.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 VERSION
 pyproject.toml
 requirements.txt
+rara_tools/converters.py
 rara_tools/decorators.py
 rara_tools/elastic.py
 rara_tools/exceptions.py
@@ -16,6 +17,7 @@ rara_tools.egg-info/top_level.txt
 rara_tools/constants/__init__.py
 rara_tools/constants/digitizer.py
 rara_tools/constants/general.py
+tests/test_converters.py
 tests/test_elastic.py
 tests/test_s3_exceptions.py
 tests/test_s3_file_operations.py

rara_tools-0.0.9/tests/test_converters.py

@@ -0,0 +1,105 @@
+import json
+import os
+
+import pytest
+from rara_tools.converters import SierraResponseConverter
+from rara_tools.exceptions import SierraResponseConverterException
+
+root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+SIERRA_TEST_DATA_DIR = os.path.join(root, "tests", "test_data", "sierra")
+INPUT_DIR = os.path.join(SIERRA_TEST_DATA_DIR, "input")
+OUTPUT_DIR = os.path.join(SIERRA_TEST_DATA_DIR, "output")
+
+example_res =  {
+            "total": 100,
+            "start": 50000,
+            "entries": [
+                {
+                    "id": 1126963,
+                    "updatedDate": "2016-02-09T08:42:52Z",
+                    "createdDate": "2014-05-17T17:22:00Z",
+                    "deleted": False,
+                    "suppressed": False,
+                    "marc": {
+                        "leader": "00000nz  a2200145n  4500",
+                        "fields": [
+                            {
+                                # "tag": "100",
+                                "data": {
+                                    "subfields": [
+                                        {
+                                            "code": "a",
+                                            "data": "Viggor, Signe,"
+                                        },
+                                        {
+                                            "code": "d",
+                                            "data": "1975-"
+                                        }
+                                    ],
+                                    "ind1": "1",
+                                    "ind2": " "
+                                }
+                            },
+            ]}}]}
+
+
+def read_json_file(file_path):
+    with open(file_path, "r") as f:
+        data = f.read()
+        return json.loads(data)
+        
+def test_convert_bibs_response():
+    response = read_json_file(os.path.join(INPUT_DIR, "bibs.json"))	
+        
+    converter = SierraResponseConverter(response)
+    data = converter.convert()
+    
+    expected = read_json_file(os.path.join(OUTPUT_DIR, "bibs.json"))    
+    assert data == expected 
+    
+    
+def test_convert_keywords_response():
+    with open(os.path.join(INPUT_DIR, "keywords.json"), "r") as f:
+        response = f.read()
+        response = json.loads(response)
+        
+    converter = SierraResponseConverter(response)
+    data = converter.convert()
+    
+    expected = read_json_file(os.path.join(OUTPUT_DIR, "keywords.json"))
+    
+    assert data == expected
+    
+    
+def test_convert_authorities_response():
+    with open(os.path.join(INPUT_DIR, "authorities.json"), "r") as f:
+        response = f.read()
+        response = json.loads(response)
+        
+    converter = SierraResponseConverter(response)
+    data = converter.convert()
+    
+    expected = read_json_file(os.path.join(OUTPUT_DIR, "authorities.json"))
+    
+    assert data == expected
+    
+def test_convert_with_wrong_format():
+    with pytest.raises(SierraResponseConverterException):
+        SierraResponseConverter("$")
+        
+def test_convert_missing_tag():
+    with pytest.raises(SierraResponseConverterException):
+        response = example_res.copy()
+        response["entries"][0]["marc"]["fields"][0].pop("tag", None)
+
+        converter = SierraResponseConverter(response)
+        converter.convert()
+    
+def test_no_entries_in_response():
+    with pytest.raises(SierraResponseConverterException):
+        response = example_res.copy()
+        response.pop("entries", [])
+
+        converter = SierraResponseConverter(response)
+        converter.convert()

{rara_tools-0.0.8 → rara_tools-0.0.9}/tests/test_elastic.py

@@ -5,7 +5,6 @@ import uuid
 from time import sleep
 
 import pytest
-
 from rara_tools.elastic import KataElastic
 
 with open("./tests/test_data/elastic_docs.json") as fh:

{rara_tools-0.0.8 → rara_tools-0.0.9}/tests/test_s3_exceptions.py

@@ -1,8 +1,9 @@
-import pytest
 import os
-from rara_tools.s3 import S3Files
-from rara_tools.exceptions import S3InitException, S3ConnectionException, S3InputException
 
+import pytest
+from rara_tools.exceptions import (S3ConnectionException, S3InitException,
+                                   S3InputException)
+from rara_tools.s3 import S3Files
 
 TEST_URL = os.getenv("S3_URL", "s3.eu-central-003.backblazeb2.com")
 TEST_ACCESS_KEY = os.getenv("S3_ACCESS_KEY", "")

{rara_tools-0.0.8 → rara_tools-0.0.9}/tests/test_task_reporter.py

@@ -1,4 +1,5 @@
 import os
+
 from rara_tools.task_reporter import TaskReporter
 
 REPORTER = TaskReporter(

rara_tools-0.0.8/VERSION

@@ -1 +0,0 @@
-0.0.8

{rara_tools-0.0.8 → rara_tools-0.0.9}/tests/test_s3_file_operations.py

@@ -1,6 +1,6 @@
-import pytest
 import os
 
+import pytest
 from rara_tools.s3 import S3Files
 
 S3_FILES = S3Files(