Finalize for kvs

Author: Pijukatel

src/apify_client/clients/resource_clients/key_value_store.py

@@ -267,7 +267,7 @@ def delete_record(self, key: str) -> None:
             timeout_secs=_SMALL_TIMEOUT,
         )
 
-    def get_record_public_rul(self, key: str) -> str:
+    def get_record_public_url(self, key: str) -> str:
         """Generate a URL that can be used to access key-value store record.
 
         If the client has permission to access the key-value store's URL signing key, the URL will include a signature
@@ -282,13 +282,20 @@ def get_record_public_rul(self, key: str) -> str:
         if self.resource_id is None:
             raise ValueError('resource_id cannot be None when generating a public URL')
 
-        public_url = f'{self._api_public_base_url}/key-value-stores/{self.resource_id}/records/{key}'
-        metadata = self.get_metadata()
+        metadata = self.get()
 
-        if metadata.url_signing_secret_key is not None:
-            public_url = public_url.with_query(signature=create_hmac_signature(metadata.url_signing_secret_key, key))
+        request_params = self._params()
 
-        return str(public_url)
+        if metadata and 'urlSigningSecretKey' in metadata:
+            request_params['signature'] = create_hmac_signature(metadata['urlSigningSecretKey'], key)
+
+        key_public_url = urlparse(self._url(f'records/{key}', public=True))
+        filtered_params = {k: v for k, v in request_params.items() if v is not None}
+
+        if filtered_params:
+            key_public_url = key_public_url._replace(query=urlencode(filtered_params))
+
+        return urlunparse(key_public_url)
 
     def create_keys_public_url(
         self,
@@ -313,7 +320,7 @@ def create_keys_public_url(
         Returns:
             The public key-value store keys URL.
         """
-        store = self.get()
+        metadata = self.get()
 
         request_params = self._params(
             limit=limit,
@@ -322,10 +329,10 @@ def create_keys_public_url(
             prefix=prefix,
         )
 
-        if store and 'urlSigningSecretKey' in store:
+        if metadata and 'urlSigningSecretKey' in metadata:
             signature = create_storage_content_signature(
-                resource_id=store['id'],
-                url_signing_secret_key=store['urlSigningSecretKey'],
+                resource_id=metadata['id'],
+                url_signing_secret_key=metadata['urlSigningSecretKey'],
                 expires_in_millis=expires_in_secs * 1000 if expires_in_secs is not None else None,
             )
             request_params['signature'] = signature
@@ -578,6 +585,36 @@ async def delete_record(self, key: str) -> None:
             timeout_secs=_SMALL_TIMEOUT,
         )
 
+    async def get_record_public_url(self, key: str) -> str:
+        """Generate a URL that can be used to access key-value store record.
+
+        If the client has permission to access the key-value store's URL signing key, the URL will include a signature
+        to verify its authenticity.
+
+        Args:
+            key: The key for which the URL should be generated.
+
+        Returns:
+            A public URL that can be used to access the value of the given key in the KVS.
+        """
+        if self.resource_id is None:
+            raise ValueError('resource_id cannot be None when generating a public URL')
+
+        metadata = await self.get()
+
+        request_params = self._params()
+
+        if metadata and 'urlSigningSecretKey' in metadata:
+            request_params['signature'] = create_hmac_signature(metadata['urlSigningSecretKey'], key)
+
+        key_public_url = urlparse(self._url(f'records/{key}', public=True))
+        filtered_params = {k: v for k, v in request_params.items() if v is not None}
+
+        if filtered_params:
+            key_public_url = key_public_url._replace(query=urlencode(filtered_params))
+
+        return urlunparse(key_public_url)
+
     async def create_keys_public_url(
         self,
         *,
@@ -601,7 +638,7 @@ async def create_keys_public_url(
         Returns:
             The public key-value store keys URL.
         """
-        store = await self.get()
+        metadata = await self.get()
 
         keys_public_url = urlparse(self._url('keys'))
 
@@ -612,10 +649,10 @@ async def create_keys_public_url(
             prefix=prefix,
         )
 
-        if store and 'urlSigningSecretKey' in store:
+        if metadata and 'urlSigningSecretKey' in metadata:
             signature = create_storage_content_signature(
-                resource_id=store['id'],
-                url_signing_secret_key=store['urlSigningSecretKey'],
+                resource_id=metadata['id'],
+                url_signing_secret_key=metadata['urlSigningSecretKey'],
                 expires_in_millis=expires_in_secs * 1000 if expires_in_secs is not None else None,
             )
             request_params['signature'] = signature

tests/integration/test_key_value_store.py

@@ -92,6 +92,21 @@ def test_public_url(self, api_token: str, api_url: str, api_public_url: str, sig
                 f'{(api_public_url or DEFAULT_API_URL).strip("/")}/v2/key-value-stores/someID/keys{expected_signature}'
             )
 
+    @pytest.mark.parametrize('signature', [None, 'custom-signature'])
+    def test_record_public_url(self, api_token: str, signature: str) -> None:
+        apify_client = ApifyClient(token=api_token)
+        kvs = apify_client.key_value_store('someID')
+
+        # Mock the API call to return predefined response
+        with mock.patch.object(
+            apify_client.http_client,
+            'call',
+            return_value=Mock(text=_get_mocked_api_kvs_response(signing_key=signature)),
+        ):
+            public_url = kvs.get_record_public_url(key='key')
+            expected_signature = f'?signature={public_url.split("signature=")[1]}' if signature else ''
+            assert public_url == (f'{DEFAULT_API_URL}/v2/key-value-stores/someID/records/key{expected_signature}')
+
 
 class TestKeyValueStoreAsync:
     async def test_key_value_store_should_create_expiring_keys_public_url_with_params(
@@ -138,7 +153,7 @@ async def test_key_value_store_should_create_public_keys_non_expiring_url(
 
     @pytest.mark.parametrize('signature', [None, 'custom-signature'])
     @parametrized_api_urls
-    async def test_public_url(self, api_token: str, api_url: str, api_public_url: str, signature: str) -> None:
+    async def test_record_public_url(self, api_token: str, api_url: str, api_public_url: str, signature: str) -> None:
         apify_client = ApifyClientAsync(token=api_token, api_url=api_url, api_public_url=api_public_url)
         kvs = apify_client.key_value_store('someID')
 
@@ -153,3 +168,18 @@ async def test_public_url(self, api_token: str, api_url: str, api_public_url: st
             assert public_url == (
                 f'{(api_public_url or DEFAULT_API_URL).strip("/")}/v2/key-value-stores/someID/keys{expected_signature}'
             )
+
+    @pytest.mark.parametrize('signature', [None, 'custom-signature'])
+    async def test_public_url(self, api_token: str, signature: str) -> None:
+        apify_client = ApifyClientAsync(token=api_token)
+        kvs = apify_client.key_value_store('someID')
+
+        # Mock the API call to return predefined response
+        with mock.patch.object(
+            apify_client.http_client,
+            'call',
+            return_value=Mock(text=_get_mocked_api_kvs_response(signing_key=signature)),
+        ):
+            public_url = await kvs.get_record_public_url(key='key')
+            expected_signature = f'?signature={public_url.split("signature=")[1]}' if signature else ''
+            assert public_url == (f'{DEFAULT_API_URL}/v2/key-value-stores/someID/records/key{expected_signature}')