enh: return private basin URL creation and expiration time

Author: paulmueller

CHANGELOG

@@ -1,3 +1,6 @@
+0.17.3
+ - enh: return private basin URL creation and expiration time
+ - setup: bump dcor_shared to 0.13.1
 0.17.2
  - enh: add basin features to served basin information (#4)
  - enh: internally cache resource metadata

ckanext/dc_serve/serve.py

@@ -2,6 +2,7 @@
 import copy
 import functools
 import logging
+import time
 
 import ckan.logic as logic
 import ckan.model as model
@@ -158,13 +159,21 @@ def get_resource_basins_dicts_private(resource_id):
     """
     basin_dicts = []
     for artifact in ["condensed", "resource"]:
-        signed_url = s3cc.create_presigned_url(resource_id, artifact=artifact)
+        time_request = time.time()
+        signed_url, expires_at = s3cc.create_presigned_url(
+            resource_id,
+            artifact=artifact,
+            expiration=3600,
+            ret_expiration=True
+            )
         basin_dicts.append({
             "name": f"{artifact}-{resource_id[:5]}",
             "format": "http",
             "type": "remote",
             "mapping": "same",
             "perishable": True,
+            "time_request": time_request,
+            "time_expiration": expires_at,
             "key": f"dcor-presigned-{artifact}-{resource_id}",
             "urls": [signed_url],
         })

ckanext/dc_serve/tests/test_serve.py

@@ -3,6 +3,7 @@
 import pathlib
 from unittest import mock
 import shutil
+import time
 import uuid
 
 import ckan.tests.factories as factories
@@ -378,6 +379,61 @@ def test_api_dcserv_basin_v2_private_presigned(enqueue_job_mock, app):
     assert "volume" in bn_cond["features"]
 
 
+@pytest.mark.ckan_config('ckan.plugins', 'dcor_schemas dc_serve')
+@pytest.mark.usefixtures('clean_db')
+@mock.patch('ckan.plugins.toolkit.enqueue_job',
+            side_effect=synchronous_enqueue_job)
+def test_api_dcserv_basin_v2_private_presigned_expiration_time(
+        enqueue_job_mock, app):
+    user = factories.UserWithToken()
+    create_context = {'ignore_auth': False,
+                      'user': user['name'],
+                      'api_version': 3}
+
+    _, res_dict = make_dataset_via_s3(
+        create_context=copy.deepcopy(create_context),
+        resource_path=data_path / "calibration_beads_47.rtdc",
+        private=True,
+        activate=True)
+    rid = res_dict["id"]
+
+    # Version two API serves basins
+    resp = app.get(
+        "/api/3/action/dcserv",
+        params={"id": rid,
+                "query": "basins",
+                "version": "2",
+                },
+        headers={"Authorization": user["token"]},
+        status=200
+    )
+    jres = json.loads(resp.body)
+    assert jres["success"]
+    basins = jres["result"]
+
+    for bn in basins:
+        assert bn["type"] == "remote"
+        assert bn["format"] == "http"
+        assert bn["perishable"]
+        assert bn["time_request"] < time.time()
+        assert bn["time_expiration"] > time.time() + 3000
+        for url in bn["urls"]:
+            assert url.lower().count("expires")
+
+    bn_cond = basins[0]
+    bn_res = basins[1]
+
+    assert bn_res["name"] == f"resource-{rid[:5]}"
+    assert "deform" in bn_res["features"]
+    assert "image" in bn_res["features"]
+    assert len(bn_res["features"]) == 34
+
+    assert bn_cond["name"] == f"condensed-{rid[:5]}"
+    assert "deform" in bn_cond["features"]
+    assert "image" not in bn_cond["features"]
+    assert "volume" in bn_cond["features"]
+
+
 @pytest.mark.ckan_config('ckan.plugins', 'dcor_schemas dc_serve')
 @pytest.mark.usefixtures('clean_db')
 @mock.patch('ckan.plugins.toolkit.enqueue_job',

pyproject.toml

@@ -29,7 +29,7 @@ license = {text = "GNU Affero General Public License v3 or later (AGPLv3+)"}
 dependencies = [
     "ckan>=2.10.4, <3",
     "dclab>=0.60.9",
-    "dcor_shared>=0.10.0",
+    "dcor_shared>=0.13.1",
 ]
 dynamic = ["version"]