✨ New Resources - File and FileBatch (#226)

* first approach of File resource

* Updatable and comments

* changed user_id approach

* changed how the user_id is uploaded

* different validation and sending form as str

* encode uploaded file and use user_id

* added tests

* updated cuenca-validation file types

* added bin dependency

* updated dependencies ?

* added FileBatch resource

* send is_back on requests

* remove line for identify

* type for batch metadata

* added clabe for users

* lint

* fixed tests

* dev dependency magic lib

* fixed cassette to current response

* generic links, removed not mine and bump validations

* remove unused stuff and bring back lines

Author: LuisBrime

cuenca/__init__.py

@@ -12,6 +12,8 @@
     'CurpValidation',
     'Commission',
     'Deposit',
+    'File',
+    'FileBatch',
     'Identity',
     'IdentityEvent',
     'LoginToken',
@@ -46,6 +48,8 @@
     Commission,
     CurpValidation,
     Deposit,
+    File,
+    FileBatch,
     Identity,
     IdentityEvent,
     LoginToken,

cuenca/http/client.py

@@ -85,8 +85,8 @@ def get(
     ) -> DictStrAny:
         return self._request_json('get', endpoint, params=params)
 
-    def post(self, endpoint: str, data: DictStrAny) -> DictStrAny:
-        return self._request_json('post', endpoint, data=data)
+    def post(self, endpoint: str, data: DictStrAny, **kwargs) -> DictStrAny:
+        return self._request_json('post', endpoint, data=data, **kwargs)
 
     def patch(self, endpoint: str, data: DictStrAny, **kwargs) -> DictStrAny:
         return self._request_json('patch', endpoint, data=data)

cuenca/resources/__init__.py

@@ -11,6 +11,8 @@
     'Commission',
     'CurpValidation',
     'Deposit',
+    'File',
+    'FileBatch',
     'Identity',
     'IdentityEvent',
     'LoginToken',
@@ -38,6 +40,8 @@
 from .commissions import Commission
 from .curp_validations import CurpValidation
 from .deposits import Deposit
+from .file_batches import FileBatch
+from .files import File
 from .identities import Identity
 from .identity_events import IdentityEvent
 from .login_tokens import LoginToken
@@ -68,6 +72,8 @@
     CurpValidation,
     Commission,
     Deposit,
+    File,
+    FileBatch,
     Identity,
     IdentityEvent,
     LoginToken,

cuenca/resources/base.py

@@ -1,4 +1,6 @@
+import base64
 import datetime as dt
+import json
 from dataclasses import asdict, dataclass, fields
 from io import BytesIO
 from typing import ClassVar, Dict, Generator, Optional, Union
@@ -121,6 +123,30 @@ def xml(self) -> bytes:
         return self.download(self, file_format=FileFormat.xml).read()
 
 
+@dataclass
+class Uploadable(Resource):
+    @classmethod
+    def _upload(
+        cls,
+        file: bytes,
+        user_id: str,
+        *,
+        session: Session = global_session,
+        **data,
+    ) -> Resource:
+        encoded_file = base64.b64encode(file)
+        resp = session.request(
+            'post',
+            cls._resource,
+            files=dict(
+                file=(None, encoded_file),
+                user_id=(None, user_id),
+                **{k: (None, v) for k, v in data.items()},
+            ),
+        )
+        return cls._from_dict(json.loads(resp))
+
+
 @dataclass
 class Queryable(Resource):
     _query_params: ClassVar = QueryParams

cuenca/resources/file_batches.py

@@ -0,0 +1,27 @@
+from typing import ClassVar, Dict, List, cast
+
+from cuenca_validations.types import BatchFileMetadata, FileBatchUploadRequest
+from pydantic.dataclasses import dataclass
+
+from ..http import Session, session as global_session
+from .base import Creatable, Queryable
+
+
+@dataclass
+class FileBatch(Creatable, Queryable):
+    _resource: ClassVar = 'file_batches'
+
+    received_files: List[BatchFileMetadata]
+    uploaded_files: List[BatchFileMetadata]
+    user_id: str
+
+    @classmethod
+    def create(
+        cls,
+        files: List[Dict],
+        user_id: str,
+        *,
+        session: Session = global_session,
+    ) -> 'FileBatch':
+        req = FileBatchUploadRequest(files=files, user_id=user_id)
+        return cast('FileBatch', cls._create(session=session, **req.dict()))

cuenca/resources/files.py

@@ -0,0 +1,82 @@
+from io import BytesIO
+from typing import ClassVar, Optional, cast
+
+from cuenca_validations.types import (
+    FileFormat,
+    FileQuery,
+    FileUploadRequest,
+    KYCFileType,
+)
+from pydantic import HttpUrl
+from pydantic.dataclasses import dataclass
+
+from ..http import Session, session as global_session
+from .base import Downloadable, Queryable, Uploadable
+
+
+@dataclass
+class File(Downloadable, Queryable, Uploadable):
+    _resource: ClassVar = 'files'
+    _query_params: ClassVar = FileQuery
+
+    extension: str
+    type: KYCFileType
+    url: HttpUrl
+    user_id: str
+
+    @classmethod
+    def upload(
+        cls,
+        file: BytesIO,
+        file_type: KYCFileType,
+        extension: Optional[str],
+        is_back: bool = False,
+        user_id: str = 'me',
+        *,
+        session: Session = global_session,
+    ) -> 'File':
+        """
+        Stores an encrypted version of the file,
+        only users with permissions can access it.
+
+        :param file:
+        :param user_id:
+        :param session:
+        :return: New encrypted file object
+        """
+        req = FileUploadRequest(
+            file=file.read(),
+            type=file_type,
+            extension=extension,
+            is_back=is_back,
+            user_id=user_id,
+        )
+        return cast(
+            'File',
+            cls._upload(
+                session=session,
+                **req.dict(),
+            ),
+        )
+
+    @property
+    def file(self) -> bytes:
+        """
+        Bytes of the decrypted file.
+        Format of the file is found on `file_type` property.
+        """
+        return self.download(self, file_format=FileFormat.any).read()
+
+    @property
+    def pdf(self) -> bytes:
+        """
+        Override from `Downloadable`, this property does not apply.
+        """
+        raise NotImplementedError
+
+    @property
+    def xml(self) -> bytes:
+        """
+        Override from `Downloadable`, this property does not apply.
+        """
+        raise NotImplementedError

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.7.14'
+__version__ = '0.7.15'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

@@ -1,3 +1,3 @@
 requests==2.27.1
-cuenca-validations==0.9.18
+cuenca-validations==0.9.20
 dataclasses>=0.7;python_version<"3.7"

setup.py

@@ -24,8 +24,8 @@
     python_requires='>=3.6',
     install_requires=[
         'requests>=2.24,<28',
-        'cuenca-validations>=0.9.18,<0.9.19',
         'dataclasses>=0.7;python_version<"3.7"',
+        'cuenca-validations>=0.9.18,<0.9.22',
     ],
     classifiers=[
         'Programming Language :: Python :: 3',

tests/conftest.py

@@ -1,4 +1,5 @@
 import datetime as dt
+from io import BytesIO
 from typing import Dict
 
 import pytest
@@ -60,3 +61,9 @@ def user_request() -> Dict:
         ),
     )
     return user_dict
+
+
+@pytest.fixture
+def file() -> BytesIO:
+    with open('tests/data/test_file.jpeg', 'rb') as image_file:
+        return BytesIO(image_file.read())