Feature/14 download method (#17)

* adds download method to ToshiFile class;
* toshiFile download tests work;
* adds download usage;
* update changelog;

Author: benjamineac

CHANGELOG.md

@@ -5,9 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
-## [0.6.2] - 2022-05-10
+## [1.0.0] - 2022-05-13
 ### Added
+- ToshiFile.download_file function
 - doco for env variables
+### Changes
+- update usage.md with download_file instruction usage
+- File.file_size from Int to BigInt
 
 ## [0.6.1] - 2022-05-05
 ### Changes

docs/usage.md

@@ -55,4 +55,27 @@ Example response
   'meta': {'mykey': 'myvalue', 'mykey2': 'myothervalue'},
   'file_url': 'https://s3.amazonaws.com/toshi-files/NZSHM22_InversionSolution-QXV0b21hdGlvblRhc2s6MTAwMTA4_nrml.zip'
 }
-```
+```
+
+To use ToshiClient.download_file in a project
+
+```
+from nshm_toshi_client import ToshiFile, API_URL, API_KEY, S3_URL
+headers={"x-api-key":API_KEY}
+api = ToshiFile(API_URL, None, None, headers=headers)
+
+example_file_path = 'usr/tmp'
+api.download_file('{example_id}', example_file_path)
+```
+
+If successful, prints:
+
+```
+saving to usr/tmp/{example_id}
+````
+
+If failure, prints:
+
+```
+Download failed: status code {status_code} (eg. 404)
+```

nshm_toshi_client/toshi_file.py

@@ -2,6 +2,7 @@
 import base64
 import json
 import logging
+import os
 from hashlib import md5
 
 import requests
@@ -123,7 +124,41 @@ def get_file(self, id, with_file_url: bool = False):
         if with_file_url:
             qry = qry.replace("#FILE_URL", "file_url")
 
-        print(qry)
+        # print(qry)
         input_variables = dict(id=id)
         executed = self.run_query(qry, input_variables)
         return executed['node']
+
+    def download_file(self, id, target_dir, target_name=None):
+        qry = '''
+        query file ($id:ID!) {
+                node(id: $id) {
+            __typename
+            ... on Node {
+              id
+            }
+            ... on FileInterface {
+              file_name
+              file_url
+            }
+          }
+        }'''
+
+        # print(qry)
+        input_variables = dict(id=id)
+        executed = self.run_query(qry, input_variables)
+        url = executed['node']['file_url']
+        filename = target_name if target_name else executed['node']['file_name']
+
+        if not os.path.exists(target_dir):
+            os.mkdir(target_dir)
+
+        file_path = os.path.join(target_dir, filename)
+
+        r = requests.get(url, stream=True)
+        if r.ok:
+            with open(file_path, 'wb') as f:
+                f.write(r.content)
+            return file_path
+        else:
+            raise (RuntimeError(f'Error downloading file {filename}: Status code {r.status_code}'))

tests/test_data/sample.zip

@@ -6,6 +6,8 @@
 from io import BytesIO
 from unittest import mock
 from pathlib import Path
+import os
+import shutil
 
 import unittest
 
@@ -117,3 +119,57 @@ def test_get_file_dowload_url_ok(self):
                 file_detail["file_url"]
                 == "https://s3.amazonaws.com/toshi-files/NZSHM22_InversionSolution-QXV0b21hdGlvblRhc2s6MTAwMTA4_nrml.zip"
             )
+
+    def mocked_requests_get(*args, **kwargs):
+        with open(Path(__file__).parent / "test_data" / "sample.zip", "rb") as f:
+            mock_zip = BytesIO(f.read())
+            mock_zip.seek(0)
+
+        class MockResponse:
+            def __init__(self, json_data, status_code, ok):
+                self.json = json_data
+                self.status_code = status_code
+                self.ok = ok
+                self.content = mock_zip.read()
+
+        if (
+            args[0]
+            == 'https://s3.amazonaws.com/toshi-files/NZSHM22_InversionSolution-QXV0b21hdGlvblRhc2s6MTAwMTA4_nrml.zip'
+        ):
+            return MockResponse({"key1": "value1"}, 200, True)
+        else:
+            return MockResponse(None, 404, False)
+
+    @mock.patch('nshm_toshi_client.toshi_file.requests.get', side_effect=mocked_requests_get)
+    def test_download_file_ok(self, mock_get):
+        with requests_mock.Mocker() as m:
+
+            query1_server_answer = '''{
+                "data": {
+                    "node": {
+                        "__typename": "InversionSolutionNrml",
+                        "id": "SW52ZXJzaW9uU29sdXRpb25Ocm1sOjEwMDM0Mw==",
+                        "file_name": "NZSHM22_InversionSolution-QXV0b21hdGlvblRhc2s6MTAwMTA4_nrml.zip",
+                        "file_url": "https://s3.amazonaws.com/toshi-files/NZSHM22_InversionSolution-QXV0b21hdGlvblRhc2s6MTAwMTA4_nrml.zip"
+                    }
+                }
+            }'''
+
+            m.post(API_URL, text=query1_server_answer)
+            headers = {"x-api-key": "THE_API_KEY"}
+            myapi = ToshiFile(API_URL, S3_URL, None, with_schema_validation=False, headers=headers)
+
+            dir_path = os.path.abspath(os.getcwd())
+            file_path = os.path.join(dir_path, "tmp")
+
+            myapi.download_file(
+                "https://s3.amazonaws.com/toshi-files/NZSHM22_InversionSolution-QXV0b21hdGlvblRhc2s6MTAwMTA4_nrml.zip",
+                file_path,
+            )
+
+            assert os.path.exists(f"{file_path}/NZSHM22_InversionSolution-QXV0b21hdGlvblRhc2s6MTAwMTA4_nrml.zip")
+
+    def tearDown(self) -> None:
+        tmp_dir = os.path.join(os.path.abspath(os.getcwd()), "tmp")
+        if os.path.exists(tmp_dir):
+            shutil.rmtree(tmp_dir)