Wallets (#181)

* wallets base model

* Add base wallet account

* WalletTransaction

* update, delete for savings

* not currency for now

* more changes savings

* query wallet transactions

* balance entries

* update cuenca-validations

* test for savings

* wallet_id in balance_entries

* serialize datetime

* test

* PR comments

* Record cassettes for tests

* Otional fields and some fixes

* Deactivable

* bump version

* lint

Co-authored-by: pachCode <arturo@cuenca.com>

Author: rogelioLpz

cuenca/__init__.py

@@ -12,11 +12,13 @@
     'Commission',
     'Deposit',
     'LoginToken',
+    'Saving',
     'ServiceProvider',
     'Statement',
     'Transfer',
     'UserCredential',
     'UserLogin',
+    'WalletTransaction',
     'WhatsappTransfer',
     'configure',
     'get_balance',
@@ -38,11 +40,13 @@
     Commission,
     Deposit,
     LoginToken,
+    Saving,
     ServiceProvider,
     Statement,
     Transfer,
     UserCredential,
     UserLogin,
+    WalletTransaction,
     WhatsappTransfer,
 )
 from .version import __version__

cuenca/http/client.py

@@ -1,3 +1,4 @@
+import datetime as dt
 import json
 import os
 from typing import Optional, Tuple
@@ -104,6 +105,12 @@ def request(
             if self.jwt_token.is_expired:
                 self.jwt_token = Jwt.create(self)
             self.session.headers['X-Cuenca-Token'] = self.jwt_token.token
+
+        if data is not None:
+            for key, value in data.items():
+                if isinstance(value, dt.date):
+                    data[key] = value.isoformat()
+
         resp = self.session.request(
             method=method,
             url='https://' + self.host + urljoin('/', endpoint),

cuenca/resources/__init__.py

@@ -11,10 +11,12 @@
     'Commission',
     'Deposit',
     'LoginToken',
+    'Saving',
     'ServiceProvider',
     'Statement',
     'Transfer',
     'UserLogin',
+    'WalletTransaction',
     'WhatsappTransfer',
 ]
 
@@ -31,11 +33,13 @@
 from .deposits import Deposit
 from .login_tokens import LoginToken
 from .resources import RESOURCES
+from .savings import Saving
 from .service_providers import ServiceProvider
 from .statements import Statement
 from .transfers import Transfer
 from .user_credentials import UserCredential
 from .user_logins import UserLogin
+from .wallet_transactions import WalletTransaction
 from .whatsapp_transfers import WhatsappTransfer
 
 # avoid circular imports
@@ -52,11 +56,13 @@
     Commission,
     Deposit,
     LoginToken,
+    Saving,
     ServiceProvider,
     Statement,
     Transfer,
     UserCredential,
     UserLogin,
+    WalletTransaction,
     WhatsappTransfer,
 ]
 for resource_cls in resource_classes:

cuenca/resources/balance_entries.py

@@ -26,6 +26,7 @@ class BalanceEntry(Retrievable, Queryable):
     type: EntryType
     related_transaction_uri: str
     funding_instrument_uri: str
+    wallet_id: str
 
     @property  # type: ignore
     def related_transaction(self) -> Transaction:

cuenca/resources/base.py

@@ -79,6 +79,22 @@ def _update(
         return cls._from_dict(resp)
 
 
+@dataclass
+class Deactivable(Resource):
+    deactivated_at: dt.datetime
+
+    @classmethod
+    def deactivate(
+        cls, id: str, *, session: Session = global_session, **data
+    ) -> Resource:
+        resp = session.delete(f'/{cls._resource}/{id}', data)
+        return cls._from_dict(resp)
+
+    @property
+    def is_active(self):
+        return not self.deactivated_at
+
+
 @dataclass
 class Downloadable(Resource):
     @classmethod
@@ -168,3 +184,13 @@ class Transaction(Retrievable, Queryable):
     amount: int  # in centavos
     status: TransactionStatus
     descriptor: str  # how it appears for the customer
+
+
+@dataclass
+class Wallet(Creatable, Deactivable, Retrievable, Queryable):
+    user_id: str
+    balance: int
+
+    @property
+    def wallet_uri(self):
+        return f'/{self._resource}/{self.id}'

cuenca/resources/savings.py

@@ -0,0 +1,56 @@
+import datetime as dt
+from dataclasses import dataclass
+from typing import ClassVar, Optional, cast
+
+from cuenca_validations.types import (
+    SavingCategory,
+    SavingRequest,
+    SavingUpdateRequest,
+    StrictPositiveInt,
+    WalletQuery,
+)
+
+from .base import Updateable, Wallet
+
+
+@dataclass
+class Saving(Wallet, Updateable):
+    _resource: ClassVar = 'savings'
+    _query_params: ClassVar = WalletQuery
+    name: str
+    category: SavingCategory
+    goal_amount: Optional[StrictPositiveInt]
+    goal_date: Optional[dt.datetime]
+
+    @classmethod
+    def create(
+        cls,
+        name: str,
+        category: SavingCategory,
+        goal_amount: Optional[int] = None,
+        goal_date: Optional[dt.datetime] = None,
+    ):
+        request = SavingRequest(
+            name=name,
+            category=category,
+            goal_amount=goal_amount,
+            goal_date=goal_date,
+        )
+        return cast('Saving', cls._create(**request.dict()))
+
+    @classmethod
+    def update(
+        cls,
+        saving_id: str,
+        name: Optional[str] = None,
+        category: Optional[SavingCategory] = None,
+        goal_amount: Optional[int] = None,
+        goal_date: Optional[dt.datetime] = None,
+    ) -> 'Saving':
+        request = SavingUpdateRequest(
+            name=name,
+            category=category,
+            goal_amount=goal_amount,
+            goal_date=goal_date,
+        )
+        return cast('Saving', cls._update(id=saving_id, **request.dict()))

cuenca/resources/wallet_transactions.py

@@ -0,0 +1,40 @@
+from dataclasses import dataclass
+from typing import ClassVar, Optional, cast
+
+from cuenca_validations.types import (
+    WalletTransactionQuery,
+    WalletTransactionRequest,
+    WalletTransactionType,
+)
+
+from cuenca.resources.base import Creatable, Transaction
+from cuenca.resources.resources import retrieve_uri
+
+from .base import Wallet
+
+
+@dataclass
+class WalletTransaction(Transaction, Creatable):
+    _resource: ClassVar = 'wallet_transactions'
+    _query_params: ClassVar = WalletTransactionQuery
+
+    transaction_type: WalletTransactionType
+    wallet_uri: str
+
+    @property
+    def wallet(self) -> Optional['Wallet']:
+        return cast('Wallet', retrieve_uri(self.wallet_uri))
+
+    @classmethod
+    def create(
+        cls,
+        wallet_uri: str,
+        transaction_type: WalletTransactionType,
+        amount: int,
+    ):
+        request = WalletTransactionRequest(
+            wallet_uri=wallet_uri,
+            transaction_type=transaction_type,
+            amount=amount,
+        )
+        return cast('WalletTransaction', cls._create(**request.dict()))

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.7.11'
+__version__ = '0.7.12'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.26.0
-cuenca-validations==0.9.10
+cuenca-validations==0.9.11
 dataclasses>=0.7;python_version<"3.7"