change Status.pending to Status.created and Status.submitted (#9)

* change Status.pending to Status.created and Status.submitted

* Fix cassettes

* Fix cassettes

* bump version

Co-authored-by: rogelioLpz <rogelio.lpz94@gmail.com>

Author: matin

README.md

@@ -13,15 +13,17 @@ import cuenca
 
 cuenca.configure(sandbox=True)  # if using sandbox
 
+local_transfer_id = '078efdc20bab456285437309c4b75673'
+
 transfer = cuenca.Transfer.create(
     recipient_name='Benito Juárez',
     account_number='646180157042875763',
     amount=12345,  # Mx$123.45
     descriptor='sending money',  # As it'll appear for the customer
-    idempotency_key='unique string',
+    idempotency_key=local_transfer_id
 )
 
-# To get updated status (estado)
+# To get updated status
 transfer.refresh()
 ```
 
@@ -51,7 +53,8 @@ import cuenca
 from cuenca.types import Status
 
 # find the unique transfer using the idempotency key
-transfer = cuenca.Transfer.one(idempotency_key='unique string')
+local_transfer_id = '078efdc20bab456285437309c4b75673'
+transfer = cuenca.Transfer.one(idempotency_key=local_transfer_id)
 
 # returns a generator of all succeeded transfers to the specific account
 transfers = cuenca.Transfer.all(
@@ -75,5 +78,5 @@ new = cuenca.ApiKey.create()
 # Have to use the new key to deactivate the old key
 old_id = cuenca.session.auth[0]
 cuenca.session.configure(new.id, new.secret)
-cuenca.ApiKey.deactivate(old_id, minutes)
+cuenca.ApiKey.deactivate(old_id, 60)  # revoke prior API key in an hour
 ```

cuenca/resources/transfers.py

@@ -51,6 +51,7 @@ def create(
         :param recipient_name: name of recipient
         :param idempotency_key: must be unique for each transfer to avoid
             duplicates
+        :return: Transfer object
 
         The recommended idempotency_key scheme:
         1. create a transfer entry in your own database with the status

cuenca/types.py

@@ -3,7 +3,8 @@
 
 
 class Status(str, Enum):
-    pending = 'pending'
+    created = 'created'
+    submitted = 'submitted'
     succeeded = 'succeeded'
     failed = 'failed'
 

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.1.1'
+__version__ = '0.1.3'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

tests/resources/cassettes/test_transfers_count_vs_all.yaml

@@ -646,7 +646,7 @@ interactions:
         Ju\u00e1rez","amount":12345,"descriptor":"sending money","idempotency_key":"421889d73dcc4af6a14cd39c54bdbaac","status":"failed","network":"internal","tracking_key":null},{"id":"TRBCbUN-jWR7iIVMTF4dw29g==","created_at":"2020-05-19T22:00:07.939000","updated_at":"2020-05-19T22:00:10.922000","account_number":"646180157042875763","recipient_name":"Benito
         Ju\u00e1rez","amount":12345,"descriptor":"sending money","idempotency_key":"a17928b8e6994a6cbbe2091e160a48e0","status":"failed","network":"internal","tracking_key":null},{"id":"TRTl-RKPIoSiabqaqX9YruFg==","created_at":"2020-05-19T22:00:06.636000","updated_at":"2020-05-19T22:00:10.131000","account_number":"646180157042875763","recipient_name":"Benito
         Ju\u00e1rez","amount":12345,"descriptor":"sending money","idempotency_key":"cf0c854c318a4b5b95c6af867c5376cf","status":"failed","network":"internal","tracking_key":null},{"id":"TRqCCl4tyBQnSyR8YvP1Og6A==","created_at":"2020-05-19T19:34:36.343000","updated_at":"2020-05-19T19:35:37.286000","account_number":"646180157034181180","recipient_name":"Rogelio","amount":10000,"descriptor":"Transferencia
-        Demo","idempotency_key":"key_roger_1","status":"pending","network":"internal","tracking_key":null},{"id":"TRhKxyL1lhQvSiMx7whOpEJA==","created_at":"2020-05-19T19:34:31.400000","updated_at":"2020-05-19T19:34:34.985000","account_number":"646180157034181180","recipient_name":"Rogelio","amount":10000,"descriptor":"Transferencia
+        Demo","idempotency_key":"key_roger_1","status":"submitted","network":"internal","tracking_key":null},{"id":"TRhKxyL1lhQvSiMx7whOpEJA==","created_at":"2020-05-19T19:34:31.400000","updated_at":"2020-05-19T19:34:34.985000","account_number":"646180157034181180","recipient_name":"Rogelio","amount":10000,"descriptor":"Transferencia
         Demo","idempotency_key":"key_roger_2","status":"succeeded","network":"internal","tracking_key":null},{"id":"TRRAnqEwwRRZWVgwbDjtAGeA==","created_at":"2020-05-19T19:07:10.018000","updated_at":"2020-05-19T19:07:14.234000","account_number":"646180157034181180","recipient_name":"Rogelio","amount":10000,"descriptor":"Transferencia
         Demo","idempotency_key":"key_roger_3","status":"succeeded","network":"internal","tracking_key":null}],"next_page_url":"/transfers?limit=100&created_before=2020-05-19T19%3A07%3A10.018000"}'
     headers:

tests/resources/cassettes/test_transfers_create.yaml

@@ -25,7 +25,7 @@ interactions:
   response:
     body:
       string: '{"id":"TRykH9-lXrS6iJocclOl4ATQ==","created_at":"2020-05-11T18:41:00.332534","updated_at":"2020-05-11T18:41:00.352103","account_number":"646180157034181180","recipient_name":"Rogelio
-        Lopez","amount":10000,"descriptor":"Mi primer transferencia","idempotency_key":"my_custom_id","status":"pending","network":"internal","tracking_key":null}'
+        Lopez","amount":10000,"descriptor":"Mi primer transferencia","idempotency_key":"my_custom_id","status":"submitted","network":"internal","tracking_key":null}'
     headers:
       Connection:
       - keep-alive

tests/resources/cassettes/test_transfers_one.yaml

@@ -19,7 +19,7 @@ interactions:
   response:
     body:
       string: '{"items":[{"id":"TR6sozlFsTQsGxzwQfWm5N_g==","created_at":"2020-05-07T17:01:30.774000","updated_at":"2020-05-07T17:01:30.794000","account_number":"646180157034181180","recipient_name":"test","amount":10000,"descriptor":"Transferencia
-        Demo","idempotency_key":"idempotency_key_1","status":"pending","network":"internal","tracking_key":null}],"next_page_url":"/transfers?idempotency_key=idempotency_key_1&created_before=2020-05-07T17%3A01%3A30.774000&limit=2&count=False"}'
+        Demo","idempotency_key":"idempotency_key_1","status":"submitted","network":"internal","tracking_key":null}],"next_page_url":"/transfers?idempotency_key=idempotency_key_1&created_before=2020-05-07T17%3A01%3A30.774000&limit=2&count=False"}'
     headers:
       Connection:
       - keep-alive

tests/resources/cassettes/test_transfers_one_errors.yaml

@@ -61,12 +61,12 @@ interactions:
       X-Cuenca-Api-Version:
       - '2020-03-19'
     method: GET
-    uri: https://sandbox.cuenca.com/transfers?status=pending&limit=2
+    uri: https://sandbox.cuenca.com/transfers?status=submitted&limit=2
   response:
     body:
       string: '{"items":[{"id":"TRIeJD25AJTCaaqd5mvSz-hA==","created_at":"2020-05-08T22:48:19.624000","updated_at":"2020-05-08T22:48:19.643000","account_number":"646180157013244941","recipient_name":"test
-        ec941f79-0c0f-4c1a-9648-4ca221103b9b","amount":8888,"descriptor":"lambda","idempotency_key":"ee3d8fbb-e2b6-4c81-94ea-b4ff240a2913","status":"pending","network":"internal","tracking_key":null},{"id":"TRo4iQvJD5TreE51v3_cVLlA==","created_at":"2020-05-08T19:53:29.917000","updated_at":"2020-05-08T19:53:29.937000","account_number":"646180157013244941","recipient_name":"pach
-        31fe4f55-b7c8-49a5-bec4-460e62b94cf9","amount":8888,"descriptor":"lambda","idempotency_key":"972a5034-91de-4fb8-99a2-9733afc4065b","status":"pending","network":"internal","tracking_key":null}],"next_page_url":"/transfers?created_before=2020-05-08T19%3A53%3A29.917000&status=pending&limit=2&count=False"}'
+        ec941f79-0c0f-4c1a-9648-4ca221103b9b","amount":8888,"descriptor":"lambda","idempotency_key":"ee3d8fbb-e2b6-4c81-94ea-b4ff240a2913","status":"submitted","network":"internal","tracking_key":null},{"id":"TRo4iQvJD5TreE51v3_cVLlA==","created_at":"2020-05-08T19:53:29.917000","updated_at":"2020-05-08T19:53:29.937000","account_number":"646180157013244941","recipient_name":"pach
+        31fe4f55-b7c8-49a5-bec4-460e62b94cf9","amount":8888,"descriptor":"lambda","idempotency_key":"972a5034-91de-4fb8-99a2-9733afc4065b","status":"submitted","network":"internal","tracking_key":null}],"next_page_url":"/transfers?created_before=2020-05-08T19%3A53%3A29.917000&status=pending&limit=2&count=False"}'
     headers:
       Connection:
       - keep-alive

tests/resources/cassettes/test_transfers_retrieve.yaml

@@ -19,7 +19,7 @@ interactions:
   response:
     body:
       string: '{"id":"test","created_at":"2020-05-07T16:57:55.833000","updated_at":"2020-05-07T16:57:55.872000","account_number":"646180157034181180","recipient_name":"test","amount":10000,"descriptor":"Transferencia
-        Demo","idempotency_key":"idempotency_key_8","status":"pending","network":"internal","tracking_key":null}'
+        Demo","idempotency_key":"idempotency_key_8","status":"submitted","network":"internal","tracking_key":null}'
     headers:
       Connection:
       - keep-alive

tests/resources/test_transfers.py

@@ -17,7 +17,7 @@ def test_transfers_create():
     assert transfer.id is not None
     assert transfer.idempotency_key is not None
     assert transfer.status
-    assert transfer.status == Status.pending
+    assert transfer.status == Status.submitted
     # Some seconds latter
     transfer.refresh()
     assert transfer.status == Status.succeeded
@@ -45,7 +45,7 @@ def test_transfers_one_errors():
         Transfer.one(idempotency_key='wrong_key')
 
     with pytest.raises(MultipleResultsFound):
-        Transfer.one(status=Status.pending)
+        Transfer.one(status=Status.submitted)
 
 
 @pytest.mark.vcr