Update SDK with one time password option

README.md

@@ -31,13 +31,15 @@ import waifuvault
 
 To Upload a file, use the `upload_file` function. This function takes the following options as an object:
 
-| Option         | Type               | Description                                                 | Required       | Extra info                       |
-|----------------|--------------------|-------------------------------------------------------------|----------------|----------------------------------|
-| `target`       | `string or buffer` | The target to upload can be a buffer, URL or filename       | true           | URL or file path                 |
-| `target_name`  | `string`           | The filename of the target if it is a buffer                | true if buffer | Filename with extension          |
-| `expires`      | `string`           | A string containing a number and a unit (1d = 1day)         | false          | Valid units are `m`, `h` and `d` |
-| `hideFilename` | `boolean`          | If true, then the uploaded filename won't appear in the URL | false          | Defaults to `false`              |
-| `password`     | `string`           | If set, then the uploaded file will be encrypted            | false          |                                  |
+| Option            | Type               | Description                                                     | Required       | Extra info                       |
+|-------------------|--------------------|-----------------------------------------------------------------|----------------|----------------------------------|
+| `target`          | `string or buffer` | The target to upload can be a buffer, URL or filename           | true           | URL or file path                 |
+| `target_name`     | `string`           | The filename of the target if it is a buffer                    | true if buffer | Filename with extension          |
+| `expires`         | `string`           | A string containing a number and a unit (1d = 1day)             | false          | Valid units are `m`, `h` and `d` |
+| `hideFilename`    | `boolean`          | If true, then the uploaded filename won't appear in the URL     | false          | Defaults to `false`              |
+| `password`        | `string`           | If set, then the uploaded file will be encrypted                | false          |                                  |
+| `oneTimeDownload` | `boolean`          | if supplied, the file will be deleted as soon as it is accessed | false          |                                  |
+
 
 Using a URL:
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "waifuvault"
-version = "1.3.2"
+version = "1.3.6"
 authors = [
     { name="Walker Aldridge", email="[email protected]" },
 ]

src/waifuvault/waifumodels.py

@@ -3,10 +3,11 @@
 
 
 class FileUpload:
-    def __init__(self, target: any, target_name: str = "unknown", expires: str = None, password: str = None, hidefilename: bool = False):
+    def __init__(self, target: any, target_name: str = "unknown", expires: str = None, password: str = None, hidefilename: bool = False, oneTimeDownload: bool = False):
         self.target = target
         self.target_name = target_name
         self.hidefilename = hidefilename
+        self.one_time_download = oneTimeDownload
         self.expires = expires
         self.password = password
 
@@ -25,13 +26,22 @@ def build_parameters(self):
         if self.expires:
             parameters['expires'] = self.expires
         if self.hidefilename:
-            parameters['hide_filename'] = self.hidefilename
+            parameters['hide_filename'] = str(self.hidefilename).lower()
+        if self.one_time_download:
+            parameters['one_time_download'] = str(self.one_time_download).lower()
         return parameters
 
 
 class FileResponse:
-    def __init__(self, token: str = None, url: str = None, protected: bool = False, retention_period: any = None):
+    def __init__(self, token: str = None, url: str = None, retention_period: any = None, options: any = None):
         self.token = token
         self.url = url
-        self.protected = protected
         self.retentionPeriod = retention_period
+        self.options = options
+
+
+class FileOptions:
+    def __init__(self, hide_filename: bool = False, one_time_download: bool = False, protected: bool = False):
+        self.hideFilename = hide_filename
+        self.oneTimeDownload = one_time_download
+        self.protected = protected

src/waifuvault/waifuvault.py

@@ -7,7 +7,7 @@
 import requests
 from requests_toolbelt import MultipartEncoder
 
-from .waifumodels import FileResponse, FileUpload
+from .waifumodels import FileResponse, FileUpload, FileOptions
 
 
 # Upload File
@@ -107,5 +107,9 @@ def __dict_to_obj(dict_obj: any):
     return FileResponse(
         dict_obj["token"],
         dict_obj["url"],
-        dict_obj["protected"],
-        dict_obj["retentionPeriod"])
+        dict_obj["retentionPeriod"],
+        FileOptions(
+            dict_obj["options"]["hideFilename"],
+            dict_obj["options"]["oneTimeDownload"],
+            dict_obj["options"]["protected"]
+        ))

tests/test_waifuvault.py

@@ -16,11 +16,11 @@ def __init__(self, ok, text, content=None, code=None):
 
 # Mocked responses
 ok_response_numeric = response_mock(True,
-                                    '{"url":"https://waifuvault.moe/f/something", "token":"test-token", "protected":false, "retentionPeriod":100}')
+                                    '{"url":"https://waifuvault.moe/f/something", "token":"test-token", "retentionPeriod":100, "options":{"protected": false, "oneTimeDownload": false, "hideFilename": false}}')
 ok_response_numeric_protected = response_mock(True,
-                                    '{"url":"https://waifuvault.moe/f/something", "token":"test-token", "protected":true, "retentionPeriod":100}')
+                                    '{"url":"https://waifuvault.moe/f/something", "token":"test-token", "retentionPeriod":100, "options":{"protected": true, "oneTimeDownload": false, "hideFilename": false}}')
 ok_response_human = response_mock(True,
-                                  '{"url":"https://waifuvault.moe/f/something", "token":"test-token", "protected":false, "retentionPeriod":"10 minutes"}')
+                                  '{"url":"https://waifuvault.moe/f/something", "token":"test-token", "retentionPeriod":"10 minutes", "options":{"protected": false, "oneTimeDownload": false, "hideFilename": false}}')
 bad_request = response_mock(False,
                             '{"name": "BAD_REQUEST", "message": "Error Test", "status": 400}',code=400)
 
@@ -42,7 +42,7 @@ def test_upload_url(mocker):
     # Then
     assert (upload_res.url == "https://waifuvault.moe/f/something"), "URL does not match"
     assert (upload_res.token == "test-token"), "Token does not match"
-    assert (upload_res.protected is False), "Protected does not match"
+    assert (upload_res.options.protected is False), "Protected does not match"
     assert (upload_res.retentionPeriod == 100), "Retention does not match"
 
 
@@ -70,7 +70,7 @@ def test_upload_file(mocker):
     mock_put.assert_called_once()
     assert (upload_res.url == "https://waifuvault.moe/f/something"), "URL does not match"
     assert (upload_res.token == "test-token"), "Token does not match"
-    assert (upload_res.protected is False), "Protected does not match"
+    assert (upload_res.options.protected is False), "Protected does not match"
     assert (upload_res.retentionPeriod == 100), "Retention does not match"
 
 
@@ -100,7 +100,7 @@ def test_upload_buffer(mocker):
     mock_put.assert_called_once()
     assert (upload_res.url == "https://waifuvault.moe/f/something"), "URL does not match"
     assert (upload_res.token == "test-token"), "Token does not match"
-    assert (upload_res.protected is False), "Protected does not match"
+    assert (upload_res.options.protected is False), "Protected does not match"
     assert (upload_res.retentionPeriod == 100), "Retention does not match"
 
 
@@ -131,7 +131,7 @@ def test_file_info(mocker):
         params={'formatted': 'true'})
     assert (upload_info.url == "https://waifuvault.moe/f/something"), "URL does not match"
     assert (upload_info.token == "test-token"), "Token does not match"
-    assert (upload_info.protected is False), "Protected does not match"
+    assert (upload_info.options.protected is False), "Protected does not match"
     assert (upload_info.retentionPeriod == "10 minutes"), "Retention does not match"
 
 
@@ -157,7 +157,7 @@ def test_update_info(mocker):
         data={'password': 'dangerWaifu','hideFilename': 'false'})
     assert (update_info.url == "https://waifuvault.moe/f/something"), "URL does not match"
     assert (update_info.token == "test-token"), "Token does not match"
-    assert (update_info.protected is True), "Protected does not match"
+    assert (update_info.options.protected is True), "Protected does not match"
     assert (update_info.retentionPeriod == 100), "Retention does not match"