Statement and downlooad with BytesIO (#97)

* Statement and downlooad with BytesIO

* link and structure resp

* fix revert

* rebase and fix

* fix endd

* tests xml

* fix lint

* fix typing

* fix linter

* change version cuenca-validations

* fix of review, matin

* file_format potitional

* fix of review

* new cassette statement xml

Author: Keryc Diaz

cuenca/__init__.py

@@ -9,6 +9,7 @@
     'Commission',
     'Deposit',
     'ServiceProvider',
+    'Statement',
     'Transfer',
     'WhatsappTransfer',
     'configure',
@@ -26,6 +27,7 @@
     Commission,
     Deposit,
     ServiceProvider,
+    Statement,
     Transfer,
     WhatsappTransfer,
 )

cuenca/http/client.py

@@ -1,3 +1,4 @@
+import json
 import os
 from typing import Optional, Tuple
 from urllib.parse import urljoin
@@ -72,20 +73,21 @@ def configure(
             self.jwt_token = Jwt.create(self)
 
     def get(
-        self,
-        endpoint: str,
-        params: ClientRequestParams = None,
+        self, endpoint: str, params: ClientRequestParams = None
     ) -> DictStrAny:
-        return self.request('get', endpoint, params=params)
+        return self._request_json('get', endpoint, params=params)
 
     def post(self, endpoint: str, data: DictStrAny) -> DictStrAny:
-        return self.request('post', endpoint, data=data)
+        return self._request_json('post', endpoint, data=data)
 
-    def patch(self, endpoint: str, data: DictStrAny) -> DictStrAny:
-        return self.request('patch', endpoint, data=data)
+    def patch(self, endpoint: str, data: DictStrAny, **kwargs) -> DictStrAny:
+        return self._request_json('patch', endpoint, data=data)
 
     def delete(self, endpoint: str, data: OptionalDict = None) -> DictStrAny:
-        return self.request('delete', endpoint, data=data)
+        return self._request_json('delete', endpoint, data=data)
+
+    def _request_json(self, *args, **kwargs) -> DictStrAny:
+        return json.loads(self.request(*args, **kwargs))
 
     def request(
         self,
@@ -94,12 +96,11 @@ def request(
         params: ClientRequestParams = None,
         data: OptionalDict = None,
         **kwargs,
-    ) -> DictStrAny:
+    ) -> bytes:
         if self.jwt_token:
             if self.jwt_token.is_expired:
                 self.jwt_token = Jwt.create(self)
             self.session.headers['X-Cuenca-Token'] = self.jwt_token.token
-
         resp = self.session.request(
             method=method,
             url='https://' + self.host + urljoin('/', endpoint),
@@ -109,7 +110,7 @@ def request(
             **kwargs,
         )
         self._check_response(resp)
-        return resp.json()
+        return resp.content
 
     @staticmethod
     def _check_response(response: Response):

cuenca/resources/__init__.py

@@ -8,6 +8,7 @@
     'Commission',
     'Deposit',
     'ServiceProvider',
+    'Statement',
     'Transfer',
     'WhatsappTransfer',
 ]
@@ -22,6 +23,7 @@
 from .deposits import Deposit
 from .resources import RESOURCES
 from .service_providers import ServiceProvider
+from .statements import Statement
 from .transfers import Transfer
 from .whatsapp_transfers import WhatsappTransfer
 
@@ -36,6 +38,7 @@
     Commission,
     Deposit,
     ServiceProvider,
+    Statement,
     Transfer,
     WhatsappTransfer,
 ]

cuenca/resources/base.py

@@ -1,9 +1,11 @@
 import datetime as dt
 from dataclasses import asdict, dataclass, fields
+from io import BytesIO
 from typing import ClassVar, Dict, Generator, Optional, Union
 from urllib.parse import urlencode
 
 from cuenca_validations.types import (
+    FileFormat,
     QueryParams,
     SantizedDict,
     TransactionQuery,
@@ -77,6 +79,32 @@ def _update(
         return cls._from_dict(resp)
 
 
+@dataclass
+class Downloadable(Resource):
+    @classmethod
+    def download(
+        cls,
+        instance,
+        file_format: FileFormat,
+        *,
+        session: Session = global_session,
+    ) -> BytesIO:
+        resp = session.request(
+            'get',
+            f'/{cls._resource}/{instance.id}',
+            headers=dict(Accept=file_format.value),
+        )
+        return BytesIO(resp)
+
+    @property
+    def pdf(self) -> bytes:
+        return self.download(self, file_format=FileFormat.pdf).read()
+
+    @property
+    def xml(self) -> bytes:
+        return self.download(self, file_format=FileFormat.xml).read()
+
+
 @dataclass
 class Queryable(Resource):
     _query_params: ClassVar = QueryParams

cuenca/resources/statements.py

@@ -0,0 +1,15 @@
+from typing import ClassVar
+
+from cuenca_validations.types import StatementQuery
+from pydantic.dataclasses import dataclass
+
+from .base import Downloadable, Queryable
+
+
+@dataclass
+class Statement(Queryable, Downloadable):
+    _resource: ClassVar = 'statements'
+    _query_params: ClassVar = StatementQuery
+
+    month: int
+    year: int

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.5.0'
+__version__ = '0.6.0'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.25.0
-cuenca-validations==0.6.9
+cuenca-validations==0.7.1
 dataclasses>=0.7;python_version<"3.7"

setup.py

@@ -25,7 +25,7 @@
     install_requires=[
         'aws-requests-auth==0.4.3',
         'requests>=2.24,<2.26',
-        'cuenca-validations>=0.6.0,<0.7.0',
+        'cuenca-validations>=0.7.0,<0.8.0',
         'dataclasses>=0.7;python_version<"3.7"',
     ],
     classifiers=[

tests/http/test_client.py

@@ -1,5 +1,5 @@
 import datetime as dt
-from unittest.mock import MagicMock, patch
+from unittest.mock import patch
 
 import pytest
 from freezegun import freeze_time
@@ -62,9 +62,8 @@ def test_request_expired_token():
 
 @patch('cuenca.http.client.requests.Session.request')
 def test_overrides_session(mock_request):
-    magic_mock = MagicMock()
-    magic_mock.json.return_value = dict(items=[])
-    mock_request.return_value = magic_mock
+    mock_request.return_value.ok = True
+    mock_request.return_value.content = '{"items": []}'
     session = Session()
     session.configure(
         api_key='USER_API_KEY', api_secret='USER_SECRET', sandbox=True