Verifications 🛂 (#242)

* First Approach of Verifications

* Lint

* Verifications review

* New cassettes done

* receiver instead of sender

* Reviews done

* Changes in our cassettes

* CV version and chaanging tests

* Alex reviews done

* Review done

Author: andreshndz

cuenca/__init__.py

@@ -27,6 +27,7 @@
     'UserCredential',
     'UserEvent',
     'UserLogin',
+    'Verification',
     'WalletTransaction',
     'Webhook',
     'WhatsappTransfer',
@@ -65,6 +66,7 @@
     UserCredential,
     UserEvent,
     UserLogin,
+    Verification,
     WalletTransaction,
     Webhook,
     WhatsappTransfer,

cuenca/resources/__init__.py

@@ -25,6 +25,7 @@
     'User',
     'UserEvent',
     'UserLogin',
+    'Verification',
     'WalletTransaction',
     'Webhook',
     'WhatsappTransfer',
@@ -58,6 +59,7 @@
 from .user_events import UserEvent
 from .user_logins import UserLogin
 from .users import User
+from .verifications import Verification
 from .wallet_transactions import WalletTransaction
 from .webhooks import Webhook
 from .whatsapp_transfers import WhatsappTransfer
@@ -91,6 +93,7 @@
     UserCredential,
     UserEvent,
     UserLogin,
+    Verification,
     WalletTransaction,
     WhatsappTransfer,
     Webhook,

cuenca/resources/base.py

@@ -71,6 +71,7 @@ def _create(cls, *, session: Session = global_session, **data) -> Resource:
 
 @dataclass
 class Updateable(Resource):
+
     updated_at: dt.datetime
 
     @classmethod

cuenca/resources/verifications.py

@@ -0,0 +1,50 @@
+import datetime as dt
+from typing import ClassVar, Optional, Union, cast
+
+from cuenca_validations.types import (
+    VerificationAttemptRequest,
+    VerificationRequest,
+    VerificationType,
+)
+from cuenca_validations.types.identities import PhoneNumber
+from pydantic import EmailStr
+from pydantic.dataclasses import dataclass
+
+from ..http import Session, session as global_session
+from .base import Creatable, Updateable
+
+
+@dataclass
+class Verification(Creatable, Updateable):
+    _resource: ClassVar = 'verifications'
+
+    recipient: Union[EmailStr, PhoneNumber]
+    type: VerificationType
+    created_at: dt.datetime
+    deactivated_at: Optional[dt.datetime]
+
+    @classmethod
+    def create(
+        cls,
+        recipient: str,
+        type: VerificationType,
+        platform_id: str,
+        session: Session = global_session,
+    ) -> 'Verification':
+        req = VerificationRequest(
+            recipient=recipient, type=type, platform_id=platform_id
+        )
+        return cast('Verification', cls._create(**req.dict(), session=session))
+
+    @classmethod
+    def verify(
+        cls,
+        id: str,
+        code: str,
+        session: Session = global_session,
+    ) -> 'Verification':
+        req = VerificationAttemptRequest(code=code)
+        return cast(
+            'Verification',
+            cls._update(id=id, **req.dict(), session=session),
+        )

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '0.7.19'
+__version__ = '0.8.0'
 CLIENT_VERSION = __version__
 API_VERSION = '2020-03-19'

requirements.txt

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

setup.py

@@ -25,7 +25,7 @@
     install_requires=[
         'requests>=2.24,<28',
         'dataclasses>=0.7;python_version<"3.7"',
-        'cuenca-validations>=0.9.23,<=0.10.*',
+        'cuenca-validations>=0.10.0,<0.11.0',
     ],
     classifiers=[
         'Programming Language :: Python :: 3',

tests/resources/cassettes/test_verification_email_create.yaml

@@ -0,0 +1,53 @@
+interactions:
+- request:
+    body: '{"type": "email", "sender": "mail@cuenca.com", "platform_id":
+      "PL01"}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '82'
+      Content-Type:
+      - application/json
+      User-Agent:
+      - cuenca-python/0.8.0.dev0
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+    method: POST
+    uri: https://sandbox.cuenca.com/verifications
+  response:
+    body:
+      string: '{"id":"VE01","recipient":"mail@cuenca.com","platform_id":"PL01","api_key":null,"type":"email","created_at":"2022-03-16T22:33:21.930707","updated_at":"2022-03-16T22:33:21.931013","deactivated_at":null}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '260'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 16 Mar 2022 22:33:22 GMT
+      X-Request-Time:
+      - 'value: 0.323'
+      x-amz-apigw-id:
+      - PGTTzHY-iYcF1zQ=
+      x-amzn-Remapped-Connection:
+      - keep-alive
+      x-amzn-Remapped-Content-Length:
+      - '260'
+      x-amzn-Remapped-Date:
+      - Wed, 16 Mar 2022 22:33:22 GMT
+      x-amzn-Remapped-Server:
+      - nginx/1.20.2
+      x-amzn-RequestId:
+      - 1403b526-7466-4985-bf8a-b8e6c156e527
+    status:
+      code: 201
+      message: Created
+version: 1

tests/resources/cassettes/test_verification_phone_create.yaml

@@ -0,0 +1,53 @@
+interactions:
+- request:
+    body: '{"type": "phone", "sender": "+525555555555", "platform_id":
+      "PL01"}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '80'
+      Content-Type:
+      - application/json
+      User-Agent:
+      - cuenca-python/0.8.0.dev0
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+    method: POST
+    uri: https://sandbox.cuenca.com/verifications
+  response:
+    body:
+      string: '{"id":"VE02","recipient":"+525555555555","platform_id":"PL01","api_key":null,"type":"phone","created_at":"2022-03-16T22:33:22.657205","updated_at":"2022-03-16T22:33:22.657613","deactivated_at":null}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '258'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 16 Mar 2022 22:33:22 GMT
+      X-Request-Time:
+      - 'value: 0.285'
+      x-amz-apigw-id:
+      - PGTT7EO2CYcFQ_w=
+      x-amzn-Remapped-Connection:
+      - keep-alive
+      x-amzn-Remapped-Content-Length:
+      - '258'
+      x-amzn-Remapped-Date:
+      - Wed, 16 Mar 2022 22:33:22 GMT
+      x-amzn-Remapped-Server:
+      - nginx/1.20.2
+      x-amzn-RequestId:
+      - 7be1235d-09b6-4bc2-b1d9-93b96ac66519
+    status:
+      code: 201
+      message: Created
+version: 1

tests/resources/cassettes/test_verification_verify.yaml

@@ -0,0 +1,52 @@
+interactions:
+- request:
+    body: '{"code": "299566"}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '18'
+      Content-Type:
+      - application/json
+      User-Agent:
+      - cuenca-python/0.8.0.dev0
+      X-Cuenca-Api-Version:
+      - '2020-03-19'
+    method: PATCH
+    uri: https://sandbox.cuenca.com/verifications/VE02
+  response:
+    body:
+      string: '{"id":"VE02","recipient":"+525529372492","platform_id":"PTW68GgAc_QPmNCmgajmctLg","api_key":null,"type":"phone","created_at":"2022-03-16T18:16:31.555000","updated_at":"2022-03-16T22:35:08.856519","deactivated_at":null}'
+    headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '337'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 16 Mar 2022 22:35:08 GMT
+      X-Request-Time:
+      - 'value: 0.120'
+      x-amz-apigw-id:
+      - PGTkhGjHCYcF4Rw=
+      x-amzn-Remapped-Connection:
+      - keep-alive
+      x-amzn-Remapped-Content-Length:
+      - '337'
+      x-amzn-Remapped-Date:
+      - Wed, 16 Mar 2022 22:35:08 GMT
+      x-amzn-Remapped-Server:
+      - nginx/1.20.2
+      x-amzn-RequestId:
+      - e6c9d46f-bc19-4cf9-bca1-e44e9e3841c6
+    status:
+      code: 200
+      message: OK
+version: 1