Fix expiry_time issue and add some new documentation

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+v1.4.1
+------
+
+- Fix comparision expiry date not resepected
+- Minor documentation update
+
 v1.4.0
 ------
 

README.md

@@ -220,6 +220,9 @@ Instances of the `ComparisonsEndpoint` class provide the following methods for r
   - If specified, the provided expiry time must be UTC and in the future
   - If unspecified or `None`, the comparison will never expire (but may be explicitly deleted)
 
+**Note: The comparision must be retrieved via the `comparisons.get(<identifier>)` call to check the 'ready' status for new comparisons. This is an important
+step before exporting or accessing consecutive comparisons in any code loops.**
+
 The following exceptions may be raised:
 
 - `BadRequest`  

VERSION

@@ -1 +1 @@
-1.4.0
+1.4.1

draftable/endpoints/comparisons/comparisons.py

@@ -71,7 +71,7 @@ def create(self, left, right, identifier=None, public=False, expires=None):
             "left": data_from_side("left", left),
             "right": data_from_side("right", right),
             "public": public,
-            "expires": expires.isoformat() if expires is not None else None,
+            "expiry_time": expires.isoformat() if expires is not None else None,
         }
 
         return comparison_from_response(self.__client.post(self.__url, data))
@@ -105,6 +105,8 @@ def signed_viewer_url(
         )
 
         param_wait = "&wait" if wait else ""
-        params = f"?valid_until={valid_until_timestamp}&signature={signature}{param_wait}"
+        params = (
+            f"?valid_until={valid_until_timestamp}&signature={signature}{param_wait}"
+        )
 
         return str(self.__url / "viewer" / self.account_id / identifier + params)

draftable/test_client.py

@@ -7,7 +7,7 @@
 
 from draftable import PRODUCTION_CLOUD_BASE_URL, Client, generate_identifier, make_side
 from draftable.endpoints.comparisons import signing
-from draftable.endpoints.validation import validate_valid_until
+from draftable.endpoints.validation import validate_expires, validate_valid_until
 from draftable.utilities import aware_datetime_to_timestamp
 
 
@@ -124,12 +124,15 @@ def test_create_retrieve_export_delete(comparisons, exports):
 
 
 def test_create_from_files(comparisons, exports):
+    when = datetime.datetime.now() + datetime.timedelta(days=1)
+
     comparison = comparisons.create(
         left="test-files/hello.pdf",
         right="test-files/hello.pdf",
-        expires=datetime.datetime.now() + datetime.timedelta(days=1),
+        expires=when,
     )
     assert not comparison.failed
+    assert comparison.expiry_time == validate_expires(when)
 
 
 def test_create_from_files_txt(comparisons, exports):