Merge pull request #19 from waifuvault/add-clear-restrictions

Add clear_restrictions, fix cache isssue in tests, fix README

README.md

@@ -15,7 +15,7 @@ pip install waifuvault
 
 ## Usage
 
-This API contains 9 interactions:
+This API contains 10 interactions:
 
 1. [Upload File](#upload-file)
 2. [Get file Info](#get-file-info)
@@ -26,6 +26,7 @@ This API contains 9 interactions:
 7. [Delete Bucket](#delete-bucket)
 8. [Get Bucket](#get-bucket)
 9. [Get Restrictions](#get-restrictions)
+10. [Clear Restrictions](#clear-restrictions)
 
 The package is namespaced to `waifuvault`, so to import it, simply:
 
@@ -246,9 +247,22 @@ To get the list of restrictions applied to the server, you use the `get_restrict
 
 This will respond with an array of name, value entries describing the restrictions applied to the server.
 
+> **NOTE:** Restrictions are cached for 10 minutes
+
 ```python
 import waifuvault
-restricions = waifuvault.get_bucket("some-bucket-token")
+restricions = waifuvault.get_restrictions()
 
 print(restrictions.Restrictions)  # Array of restriction objects
+```
+
+### Clear Restrictions<a id="clear-restrictions"></a>
+
+To clear the cached restrictions in the SDK, you use the `clear_restrictions` function.
+
+This will remove the cached restrictions and a fresh copy will be downloaded at the next upload.
+
+```python
+import waifuvault
+waifuvault.clear_restrictions()
 ```

src/waifuvault/__init__.py

@@ -1,3 +1,3 @@
 from .waifumodels import FileResponse, FileUpload, BucketResponse, Restriction, RestrictionResponse
 from .waifuvault import (upload_file, file_info, get_file, delete_file, file_update, create_bucket, get_bucket,
-                         delete_bucket, get_restrictions)
+                         delete_bucket, get_restrictions, clear_restrictions)

src/waifuvault/waifuvault.py

@@ -20,6 +20,12 @@ def get_restrictions():
     return RestrictionResponse(rest_obj=json.loads(response.text))
 
 
+# Clear Restrictions
+def clear_restrictions():
+    global __restrictions
+    __restrictions = None
+
+
 # Create Bucket
 def create_bucket():
     url = f"{__base_url__}/bucket/create"

tests/test_waifuvault.py

@@ -151,13 +151,12 @@ def test_upload_buffer_error(mocker):
 
 def test_upload_restriction_error(mocker):
     # Given
+    waifuvault.clear_restrictions()
     mock_put = mocker.patch('requests.put', return_value=bad_request)
     mock_get = mocker.patch('requests.get', return_value=restrictions_small_response)
-    with open("tests/testfile.png", "rb") as fh:
-        buf = io.BytesIO(fh.read())
 
     # When
-    upload_file = waifuvault.FileUpload(buf, "testfile_buf.png", expires="10m")
+    upload_file = waifuvault.FileUpload("tests/testfile.png", expires="10m")
 
     # Then
     with pytest.raises(Exception, match=re.escape('File size 97674 is larger than max allowed 100')):