dcor-shared 1.0.2__tar.gz → 1.0.4__tar.gz

{dcor_shared-1.0.2 → dcor_shared-1.0.4}/CHANGELOG

@@ -1,3 +1,8 @@
+1.0.4
+ - enh: implement "artifact" kwarg for `s3cc.compute_checksum`
+ - enh: introduce `enable_basins` in `s3cc.get_s3_dc_handle`
+1.0.3
+ - enh: allow to specify resource name when creating test resource
 1.0.2
  - ref: disable threading and use 1GiB threshold for multipart uploads
 1.0.1

{dcor_shared-1.0.2 → dcor_shared-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dcor_shared
-Version: 1.0.2
+Version: 1.0.4
 Summary: Functionalities shared by the DCOR CKAN extensions
 Author: Paul Müller
 Maintainer-email: Paul Müller <dev@craban.de>

{dcor_shared-1.0.2 → dcor_shared-1.0.4}/dcor_shared/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.0.2'
-__version_tuple__ = version_tuple = (1, 0, 2)
+__version__ = version = '1.0.4'
+__version_tuple__ = version_tuple = (1, 0, 4)

{dcor_shared-1.0.2 → dcor_shared-1.0.4}/dcor_shared/s3cc.py

@@ -34,10 +34,12 @@ def artifact_exists(
     return s3.object_exists(bucket_name=bucket_name, object_name=object_name)
 
 
-def compute_checksum(resource_id):
+def compute_checksum(
+        resource_id: str,
+        artifact: Literal["condensed", "preview", "resource"] = "resource"):
     """Compute the SHA256 checksum of the corresponding CKAN resource"""
     bucket_name, object_name = get_s3_bucket_object_for_artifact(
-        resource_id=resource_id, artifact="resource")
+        resource_id=resource_id, artifact=artifact)
     s3h = s3.compute_checksum(bucket_name=bucket_name, object_name=object_name)
     return s3h
 
@@ -188,12 +190,19 @@ def get_s3_bucket_name_for_resource(resource_id):
 
 def get_s3_dc_handle(
         resource_id: str,
-        artifact: Literal["condensed", "preview", "resource"] = "resource"):
+        artifact: Literal["condensed", "preview", "resource"] = "resource",
+        enable_basins: bool = False,
+        ):
     """Return an instance of :class:`RTDC_S3`
 
     The data are accessed directly via S3 using DCOR's access credentials.
     Use this if you need to access the original raw file.
 
+    If you set `enable_basins` to True, basins of the data on S3 will
+    be considered. This is turned off for performance reasons. Note that
+    since an instance of `RTDC_S3` is returned, no local basins are
+    allowed.
+
     The resource with the identifier `resource_id` must exist in the
     CKAN database.
     """
@@ -204,9 +213,7 @@ def get_s3_dc_handle(
             "dcor_object_store.access_key_id"),
         secret_access_key=get_ckan_config_option(
             "dcor_object_store.secret_access_key"),
-        # Disable basins, because they could point to files on the
-        # local file system (security).
-        enable_basins=False,
+        enable_basins=enable_basins,
     )
     return ds
 

{dcor_shared-1.0.2 → dcor_shared-1.0.4}/dcor_shared/testing.py

@@ -149,11 +149,14 @@ def make_resource_via_s3(
         resource_path: pathlib.Path | str,
         organization_id: str,
         dataset_id: str,
+        resource_name: str = None,
         private: bool = False,
         ret_dict: bool = False,
         ):
     """Upload a resource to S3 and register it with CKAN"""
     resource_path = pathlib.Path(resource_path)
+    if resource_name is None:
+        resource_name = resource_path.name
 
     user = factories.Sysadmin()
     create_context = {'ignore_auth': False,
@@ -175,7 +178,7 @@ def make_resource_via_s3(
         "match": {"id": dataset_id},
         "update__resources__extend": [{
             "id": rid,
-            "name": resource_path.name,
+            "name": resource_name,
             "s3_available": True,
             }]
         }

{dcor_shared-1.0.2 → dcor_shared-1.0.4}/dcor_shared.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dcor_shared
-Version: 1.0.2
+Version: 1.0.4
 Summary: Functionalities shared by the DCOR CKAN extensions
 Author: Paul Müller
 Maintainer-email: Paul Müller <dev@craban.de>

{dcor_shared-1.0.2 → dcor_shared-1.0.4}/tests/test_testing.py

@@ -2,9 +2,12 @@ import pathlib
 import pytest
 
 import ckan.tests.factories as factories
+import ckan.tests.helpers as helpers
 import requests
 
-from dcor_shared.testing import make_dataset_via_s3
+from dcor_shared.testing import (
+    make_dataset_via_s3, make_resource_via_s3, activate_dataset
+)
 from dcor_shared import s3cc, sha256sum
 
 data_path = pathlib.Path(__file__).parent / "data"
@@ -47,3 +50,26 @@ def test_make_dataset_with_resource_via_s3(tmp_path):
 
     assert sha256sum(dl_path) == \
            "490efdf5d9bb4cd4b2a6bcf2fe54d4dc201c38530140bcb168980bf8bf846c73"
+
+    assert res_dict["name"] == "calibration_beads_47.rtdc"
+
+
+@pytest.mark.ckan_config('ckan.plugins', 'dcor_schemas')
+@pytest.mark.usefixtures('clean_db', 'with_request_context')
+def test_make_resource_via_s3_name(tmp_path):
+    # upload a *valid* [sic] .rtdc File (this is the control)
+    ds_dict = make_dataset_via_s3(
+        activate=False,
+        private=False,
+    )
+    rid = make_resource_via_s3(
+        resource_path=data_path / "calibration_beads_47.rtdc",
+        resource_name="peter.rtdc",
+        organization_id=ds_dict["organization"]["id"],
+        dataset_id=ds_dict["id"],
+        private=False,
+    )
+    activate_dataset(ds_dict["id"])
+
+    res_dict = helpers.call_action("resource_show", id=rid)
+    assert res_dict["name"] == "peter.rtdc"