Merge branch 'release/3.4.0'

Author: Bartek Kwiecien

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Filestack-Python Changelog
 
+### 3.4.0 (May 13th, 2021)
+- Store upload response in Filelink object [#59](https://github.com/filestack/filestack-python/pull/59)
+
 ### 3.3.0 (March 12th, 2021)
 - Added Image OCR [#52](https://github.com/filestack/filestack-python/pull/52)
 - Changed how files from external urls are uploaded [#54](https://github.com/filestack/filestack-python/pull/54)

VERSION

@@ -1 +1 @@
-3.3.0
+3.4.0

docs/source/uploading_files.rst

@@ -47,7 +47,7 @@ To upload in-memory bytes:
     bytes_to_upload = b'content'
 
     cli = Client('<FILESTACK_APIKEY>')
-    filelink = cli.uploads(file_obj=io.BytesIO(bytes_to_upload))
+    filelink = cli.upload(file_obj=io.BytesIO(bytes_to_upload))
 
 
 External urls

filestack/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '3.3.0'
+__version__ = '3.4.0'
 
 
 class CFG:

filestack/models/client.py

@@ -120,8 +120,13 @@ def upload_url(self, url, store_params=None, security=None):
             :class:`filestack.Filelink`: new Filelink object
         """
         sec = security or self.security
-        handle = upload_external_url(url, self.apikey, store_params, security=sec)
-        return filestack.models.Filelink(handle=handle, security=sec)
+        upload_response = upload_external_url(url, self.apikey, store_params, security=sec)
+        return filestack.models.Filelink(
+            handle=upload_response['handle'],
+            apikey=self.apikey,
+            security=sec,
+            upload_response=upload_response
+        )
 
     def upload(self, *, filepath=None, file_obj=None, store_params=None, intelligent=False, security=None):
         """
@@ -154,4 +159,9 @@ def upload(self, *, filepath=None, file_obj=None, store_params=None, intelligent
         )
 
         handle = response_json['handle']
-        return filestack.models.Filelink(handle, apikey=self.apikey, security=self.security)
+        return filestack.models.Filelink(
+            handle,
+            apikey=self.apikey,
+            security=self.security,
+            upload_response=response_json
+        )

filestack/models/filelink.py

@@ -15,7 +15,7 @@ class Filelink(ImageTransformationMixin, CommonMixin):
     >>> flink.url
     'https://cdn.filestackcontent.com/sm9IEXAMPLEQuzfJykmA'
     """
-    def __init__(self, handle, apikey=None, security=None):
+    def __init__(self, handle, apikey=None, security=None, upload_response=None):
         """
         Args:
             handle (str): The path of the file to wrap
@@ -26,6 +26,7 @@ def __init__(self, handle, apikey=None, security=None):
         self.apikey = apikey
         self.handle = handle
         self.security = security
+        self.upload_response = upload_response
 
     def __repr__(self):
         return '<Filelink {}>'.format(self.handle)

filestack/uploads/external_url.py

@@ -28,4 +28,4 @@ def upload_external_url(url, apikey, store_params=None, security=None):
         })
 
     response = requests.post('{}/process'.format(config.CDN_URL), json=payload)
-    return response.json()['handle']
+    return response.json()

tests/client_test.py

@@ -53,7 +53,7 @@ def test_store_filepath(upload_mock, client):
 @patch('filestack.models.client.multipart_upload')
 @patch('filestack.models.client.upload_external_url')
 def test_security_inheritance(upload_external_mock, multipart_mock):
-    upload_external_mock.return_value = 'URL_HANDLE'
+    upload_external_mock.return_value = {'handle': 'URL_HANDLE'}
     multipart_mock.return_value = {'handle': 'FILE_HANDLE'}
 
     policy = {'expiry': 1900}

tests/uploads/test_upload_external_url.py

@@ -42,7 +42,7 @@ def test_upload_with_store_params(post_mock, store_params, security, expected_st
     }
     post_mock.return_value = DummyHttpResponse(json_dict={'handle': 'newHandle'})
 
-    handle = upload_external_url(url, apikey, store_params=store_params, security=security)
-    assert handle == 'newHandle'
+    upload_response = upload_external_url(url, apikey, store_params=store_params, security=security)
+    assert upload_response['handle'] == 'newHandle'
     post_args, _ = post_mock.call_args
     post_mock.assert_called_once_with('{}/process'.format(config.CDN_URL), json=expected_payload)