Adding name to balance entries model (#72)

* adding name to balance entries model

* add type

* remove transaction_uri

* add cassettess and tests for balance entries

* fix covergae

* removed unecesarry parts from cassettes

* update cuenca-validations version

* update cuenca-validations version to 0.6.4

* update version

Author: agarrido19

cuenca/resources/balance_entries.py

@@ -1,7 +1,10 @@
-from typing import ClassVar
+from typing import ClassVar, cast
 
+from cuenca_validations.types import EntryType, RelatedTransaction
 from pydantic.dataclasses import dataclass
 
+from cuenca import resources
+
 from .base import Queryable, Retrievable
 from .resources import retrieve_uri
 
@@ -12,9 +15,13 @@ class BalanceEntry(Retrievable, Queryable):
 
     amount: int  # negative in the case of a debit
     descriptor: str
+    name: str
     rolling_balance: int
-    transaction_uri: str
+    type: EntryType
+    related_transaction_uri: RelatedTransaction
 
     @property  # type: ignore
-    def transaction(self):
-        return retrieve_uri(self.transaction_uri)
+    def related_transaction(self):
+        rt = self.related_transaction_uri
+        resource = getattr(resources, rt.get_model())
+        return cast(resource, retrieve_uri(rt)) if resource else None

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.3.6'
+__version__ = '0.3.7'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,4 +1,4 @@
 requests==2.24.0
-cuenca-validations==0.6.2
+cuenca-validations==0.6.4
 dataclasses>=0.7;python_version<"3.7"
 aws-requests-auth==0.4.3

tests/resources/cassettes/test_balance_entry_related_transaction_not_exist.yaml

@@ -0,0 +1,103 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      User-Agent:
+      - cuenca-python/0.3.6
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+      x-amz-content-sha256:
+      - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      x-amz-date:
+      - 20201019T180526Z
+    method: GET
+    uri: https://sandbox.cuenca.com/balance_entries/TV02
+  response:
+    body:
+      string: '{"id":"TV02","created_at":"2020-10-15T22:27:53.786000","user_id":"US4CUUYCzSBj8494zjbmF7Np","name":"Cargo
+        a cuenta","amount":1000,"descriptor":"Comisi\u00f3n por dep\u00f3sito de efectivo","rolling_balance":176000,"type":"credit","related_transaction_uri":"/commissions/CO3FI2mQsprTNhoik7Ni1VQF"}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '316'
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 19 Oct 2020 18:05:27 GMT
+      Via:
+      - 1.1 f70a58ce7ab3276e2d4987075b643aea.cloudfront.net (CloudFront)
+      X-Amz-Cf-Id:
+      - b5skJUNS0zQrIBkcgS1s25ms89NQ-xsO8lbvcKvdivKE3_YpHNrLgw==
+      X-Amz-Cf-Pop:
+      - LAX50-C2
+      X-Amzn-Trace-Id:
+      - Root=1-5f8dd567-114ed07a0f869fb17dd7e8ea;Sampled=0
+      X-Cache:
+      - Miss from cloudfront
+      x-amz-apigw-id:
+      - Uq5INFTbIAMFZYQ=
+      x-amzn-RequestId:
+      - 6f80aa4f-6410-4042-9267-0bc9ecae7711
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      User-Agent:
+      - cuenca-python/0.3.6
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+      x-amz-content-sha256:
+      - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      x-amz-date:
+      - 20201019T180527Z
+    method: GET
+    uri: https://sandbox.cuenca.com/commissions/CO3FI2mQsprTNhoik7Ni1VQF
+  response:
+    body:
+      string: '{"Code":"NotFoundError","Message":"NotFoundError: Not valid id"}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '64'
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 19 Oct 2020 18:05:28 GMT
+      Via:
+      - 1.1 f70a58ce7ab3276e2d4987075b643aea.cloudfront.net (CloudFront)
+      X-Amz-Cf-Id:
+      - WfLqxzb9brwwjAuXAM0NhGWKvfCYIoVPq4Dk0P7uKwZRNhNnqn9Uaw==
+      X-Amz-Cf-Pop:
+      - LAX50-C2
+      X-Amzn-Trace-Id:
+      - Root=1-5f8dd568-5ff7c82f4990f22c55adce5f;Sampled=0
+      X-Cache:
+      - Error from cloudfront
+      x-amz-apigw-id:
+      - Uq5IVFX9IAMFcTg=
+      x-amzn-RequestId:
+      - 4260df4a-cd37-49e8-b099-b6bc7a5579e4
+    status:
+      code: 404
+      message: Not Found
+version: 1

tests/resources/cassettes/test_balance_entry_retrieve.yaml

@@ -11,38 +11,42 @@ interactions:
       Connection:
       - keep-alive
       User-Agent:
-      - cuenca-python/0.2.0.dev1
+      - cuenca-python/0.3.6
       X-Cuenca-Api-Version:
       - '2020-03-19'
+      x-amz-content-sha256:
+      - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      x-amz-date:
+      - 20201019T172955Z
     method: GET
     uri: https://sandbox.cuenca.com/balance_entries/TV01
   response:
     body:
-      string: '{"id":"TV01","created_at":"2020-06-01T03:07:27.879000","amount":10000,"descriptor":"Test
-        deposit","rolling_balance":10000,"transaction_uri":"/deposits/SP01"}'
+      string: '{"id":"TV01","created_at":"2020-10-15T22:27:53.712000","user_id":"US4PCNV8rLB2wqBfORzIAXUl","name":"Dep\u00f3sito
+        de efectivo","amount":25000,"descriptor":"Deposito v\u00eda paynet auth 304054","rolling_balance":144519,"type":"credit","related_transaction_uri":"/deposits/CDI7SJOifauN5WnqfMhXK4R"}'
     headers:
       Connection:
       - keep-alive
       Content-Length:
-      - '157'
+      - '317'
       Content-Type:
       - application/json
       Date:
-      - Tue, 16 Jun 2020 03:43:47 GMT
+      - Mon, 19 Oct 2020 17:29:56 GMT
       Via:
-      - 1.1 2e7e64e85275c7c3d580e9eab0385c03.cloudfront.net (CloudFront)
+      - 1.1 1f2a017323162153f3cbc068c08d683d.cloudfront.net (CloudFront)
       X-Amz-Cf-Id:
-      - 8AKT32IyjJ2xsUV6Ovwo3JtsOMyjTBzCo7HkvELoFRP_e6G9faXkmA==
+      - jmXPfoX1V3D4gfK2oNRvYyCVTa0H4CFDq2UIJW0k5H98ZXDVOwuVUA==
       X-Amz-Cf-Pop:
-      - JFK51-C1
+      - LAX50-C2
       X-Amzn-Trace-Id:
-      - Root=1-5ee83ff3-0388090aa11c07e20440f246;Sampled=0
+      - Root=1-5f8dcd14-062b68864a68a14d561f7483;Sampled=0
       X-Cache:
       - Miss from cloudfront
       x-amz-apigw-id:
-      - OM7uAF3JoAMF2GA=
+      - Uqz7NGGKoAMFuzg=
       x-amzn-RequestId:
-      - ee92b173-840e-47ab-8041-876d99d24102
+      - 3c4972d3-4bb0-45b6-99d9-b184ad9102f9
     status:
       code: 200
       message: OK
@@ -58,38 +62,42 @@ interactions:
       Connection:
       - keep-alive
       User-Agent:
-      - cuenca-python/0.2.0.dev1
+      - cuenca-python/0.3.6
       X-Cuenca-Api-Version:
       - '2020-03-19'
+      x-amz-content-sha256:
+      - e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      x-amz-date:
+      - 20201019T172956Z
     method: GET
-    uri: https://sandbox.cuenca.com/deposits/SP01
+    uri: https://sandbox.cuenca.com/deposits/CDI7SJOifauN5WnqfMhXK4R
   response:
     body:
-      string: '{"id":"SP01","created_at":"2020-06-03T03:07:36.338000","amount":10000,"status":"succeeded","descriptor":"SPEI
-        1","source_uri":"/accounts/BA01","network":"spei","tracking_key":"RASTREO_1234","user_id":"US01"}'
+      string: '{"id":"CDI7SJOifauN5WnqfMhXK4R","created_at":"2020-10-15T22:27:53.827000","user_id":"US4PCNV8rLB2wqBfORzIAXUl","amount":25000,"status":"succeeded","descriptor":"Deposito
+        v\u00eda paynet auth 304054","source_uri":null,"network":"cash","tracking_key":null}'
     headers:
       Connection:
       - keep-alive
       Content-Length:
-      - '190'
+      - '254'
       Content-Type:
       - application/json
       Date:
-      - Tue, 16 Jun 2020 03:43:51 GMT
+      - Mon, 19 Oct 2020 17:29:57 GMT
       Via:
-      - 1.1 2e7e64e85275c7c3d580e9eab0385c03.cloudfront.net (CloudFront)
+      - 1.1 1f2a017323162153f3cbc068c08d683d.cloudfront.net (CloudFront)
       X-Amz-Cf-Id:
-      - 8f7zBxOkJlxr-hiBS-R19S0onB1iR1TgTtKR6vEmkUN_eVkXPDpe-Q==
+      - Oca8s1d7DyjaJBtN-bGe_6DgjyLBUCYwZ6KV07FAoawSmfGM2zS5Eg==
       X-Amz-Cf-Pop:
-      - JFK51-C1
+      - LAX50-C2
       X-Amzn-Trace-Id:
-      - Root=1-5ee83ff7-f4b1d5056df6a7219645fa39;Sampled=0
+      - Root=1-5f8dcd15-4a3f9ad77ee830f7704af8b5;Sampled=0
       X-Cache:
       - Miss from cloudfront
       x-amz-apigw-id:
-      - OM7utGv3IAMFf6g=
+      - Uqz7UG_QIAMFVtQ=
       x-amzn-RequestId:
-      - 0e4fa451-7a8a-4e46-867d-0547f72ac39c
+      - 75f5428f-9a18-455b-9984-cc3e80fbde4b
     status:
       code: 200
       message: OK

tests/resources/cassettes/test_commission_retrieve_witw_deposit.yaml

@@ -50,53 +50,6 @@ interactions:
     status:
       code: 200
       message: OK
-- request:
-    body: null
-    headers:
-      Accept:
-      - '*/*'
-      Accept-Encoding:
-      - gzip, deflate
-      Connection:
-      - keep-alive
-      User-Agent:
-      - python-requests/2.24.0
-    method: GET
-    uri: https://sandbox.cuenca.com/config/route_configuration.json
-  response:
-    body:
-      string: "{\n    \"default_route\": \"/oaxaca\",\n    \"routes\": {\n       \
-        \ \"cards\": \"/knox\",\n        \"api_keys\": \"/authed\"\n    }\n}\n"
-    headers:
-      Accept-Ranges:
-      - bytes
-      Age:
-      - '1622'
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '114'
-      Content-Type:
-      - application/json
-      Date:
-      - Thu, 01 Oct 2020 18:27:33 GMT
-      ETag:
-      - '"f35b9f1de4b47e51d5a9b8706ef54e6b"'
-      Last-Modified:
-      - Tue, 15 Sep 2020 22:51:15 GMT
-      Server:
-      - AmazonS3
-      Via:
-      - 1.1 19934e8c827f304089a6e45a640882cd.cloudfront.net (CloudFront)
-      X-Amz-Cf-Id:
-      - qPWYfE69Ef2tZYj9FciaKOvxYaD84CHV1P-eeqRX8BLnX2Tspp3ufA==
-      X-Amz-Cf-Pop:
-      - DFW55-C1
-      X-Cache:
-      - Hit from cloudfront
-    status:
-      code: 200
-      message: OK
 - request:
     body: null
     headers:

tests/resources/test_balance_entries.py

@@ -1,13 +1,24 @@
 import pytest
 
 from cuenca import BalanceEntry
+from cuenca.exc import CuencaResponseException
 
 
 @pytest.mark.vcr
 def test_balance_entry_retrieve():
     id_entry = 'TV01'
     balance_entry: BalanceEntry = BalanceEntry.retrieve(id_entry)
     assert balance_entry.id == id_entry
+    txn = balance_entry.related_transaction
+    assert (
+        balance_entry.related_transaction_uri == f'/{txn._resource}/{txn.id}'
+    )
 
-    txn = balance_entry.transaction
-    assert balance_entry.transaction_uri == f'/{txn._resource}/{txn.id}'
+
+@pytest.mark.vcr
+def test_balance_entry_related_transaction_not_exist():
+    id_entry = 'TV02'
+    balance_entry: BalanceEntry = BalanceEntry.retrieve(id_entry)
+    assert balance_entry.id == id_entry
+    with pytest.raises(CuencaResponseException):
+        balance_entry.related_transaction