feat: adds invaliteToken endpoint

Author: andrextor

CHANGELOG.md

@@ -10,6 +10,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Initial release of Checkout P2P version 1.0.0.
-- Support for **query**, **single payments**, **subscriptions**, **payments using subscription tokens** and **reverse**.
+- Support for **query**, **single payments**, **subscriptions**, **payments using subscription tokens**, **Invalidate token** and **reverse**.
 - Added Pydantic-based validation for request and response models.
 - Decorators to format booleans and clean dictionaries for API compatibility.

checkout/checkout.py

@@ -2,14 +2,16 @@
 
 from checkout.contracts.carrier import Carrier
 from checkout.entities.settings import Settings
+from checkout.entities.status import Status
 from checkout.exceptions.checkout_exception import CheckoutException
 from checkout.messages.requests.collect import CollectRequest
+from checkout.messages.requests.invalidate_token import InvalidateToKenRequest
 from checkout.messages.requests.redirect import RedirectRequest
 from checkout.messages.responses.information import InformationResponse
 from checkout.messages.responses.redirect import RedirectResponse
 from checkout.messages.responses.reverse import ReverseResponse
 
-T = TypeVar("T", RedirectRequest, CollectRequest)
+T = TypeVar("T", RedirectRequest, CollectRequest, InvalidateToKenRequest)
 
 
 class Checkout:
@@ -26,7 +28,9 @@ def __init__(self, data: Dict[str, Any]) -> None:
         self.settings: Settings = Settings(**data)
         self.logger = self.settings.logger()
 
-    def _validate_request(self, request: Union[RedirectRequest, CollectRequest, Dict], expected_class: Type[T]) -> T:
+    def _validate_request(
+        self, request: Union[RedirectRequest, CollectRequest, InvalidateToKenRequest, Dict], expected_class: Type[T]
+    ) -> T:
         """
         Validate the request object and convert it to the expected class if necessary.
 
@@ -98,3 +102,13 @@ def reverse(self, internal_reference: str) -> ReverseResponse:
         """
         self.logger.info(f"Reversing transaction with reference: {internal_reference}.")
         return self.carrier.reverse(internal_reference)
+
+    def invalidateToken(self, invalidate_token_request: Union[InvalidateToKenRequest, Dict]) -> Status:
+        """
+        Reverse a transaction.
+
+        :param invalidate_token_request: InvalidateToKenRequest instance or dictionary with request data.
+        :return: Status object.
+        """
+        invalidate_token_request = self._validate_request(invalidate_token_request, InvalidateToKenRequest)
+        return self.carrier.invalidateToken(invalidate_token_request)

checkout/clients/rest_client.py

@@ -1,10 +1,10 @@
 from typing import Dict
 
 from checkout.contracts.carrier import Carrier
-from checkout.entities.instrument import Instrument
 from checkout.entities.settings import Settings
 from checkout.entities.status import Status
 from checkout.messages.requests.collect import CollectRequest
+from checkout.messages.requests.invalidate_token import InvalidateToKenRequest
 from checkout.messages.requests.redirect import RedirectRequest
 from checkout.messages.responses.information import InformationResponse
 from checkout.messages.responses.redirect import RedirectResponse
@@ -59,9 +59,10 @@ def reverse(self, transaction_id: str) -> ReverseResponse:
         result = self._post("api/reverse", {"internalReference": transaction_id})
         return ReverseResponse(**result)
 
-    def invalidateToken(self, instrument: Instrument) -> Status:
+    def invalidateToken(self, invalidate_token_request: InvalidateToKenRequest) -> Status:
         """
         Invalidate a token.
         """
-        result = self._post("/api/instrument/invalidate", {"instrument": instrument.to_dict()})
-        return Status(**result)
+        result = self._post("/api/instrument/invalidate", invalidate_token_request.to_dic())
+
+        return Status.from_dict(result)

checkout/contracts/carrier.py

@@ -1,8 +1,8 @@
 from typing import Protocol
 
-from checkout.entities.instrument import Instrument
 from checkout.entities.status import Status
 from checkout.messages.requests.collect import CollectRequest
+from checkout.messages.requests.invalidate_token import InvalidateToKenRequest
 from checkout.messages.requests.redirect import RedirectRequest
 from checkout.messages.responses.information import InformationResponse
 from checkout.messages.responses.redirect import RedirectResponse
@@ -30,7 +30,7 @@ def reverse(self, transaction_id: str) -> ReverseResponse:
         Reverse a transaction by its ID.
         """
 
-    def invalidateToken(self, instrument: Instrument) -> Status:
+    def invalidateToken(self, invalidate_token_request: InvalidateToKenRequest) -> Status:
         """
         invalidate a token.
         """

checkout/entities/status.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Optional
+from typing import Dict, Optional
 
 from pydantic import BaseModel, Field
 
@@ -34,6 +34,19 @@ def quick(
     ) -> "Status":
         return cls(status=status, reason=reason, message=message, date=date)
 
+    @classmethod
+    def from_dict(cls, data: Dict) -> "Status":
+        """
+        Create a Status instance from a dictionary.
+        """
+        status_data = data.get("status", {})
+        return cls(
+            status=StatusEnum(status_data["status"]),
+            reason=status_data["reason"],
+            message=status_data.get("message", ""),
+            date=status_data.get("date", datetime.now().isoformat()),
+        )
+
     def to_dict(self) -> dict:
         """
         Convert the Status object to a dictionary.

checkout/tests/feature/test_checkout.py

@@ -216,6 +216,23 @@ def test_reverse_valid(self, mock_post, mock_response):
         self.assertEqual(payment.processor_fields[-1].value, "00")
         self.assertEqual(payment.processor_fields[-1].keyword, "b24")
 
+    @patch("requests.post")
+    @RedirectResponseMock.mock_response_decorator("invalidate_token_response_successful")
+    def test_invalidate_token_succssful(self, mock_post, mock_response):
+        mock_post.return_value = mock_response
+
+        instrument = Instrument(
+            token=Token(
+                token="5caef08ecd1230088a12e8f7d9ce20e9134dc6fc049c8a4857c9ba6e942b16b2", subtoken="test_subtoken"
+            )
+        )
+        invalidate_token_request = {"locale": "en_US", "instrument": instrument}
+        result = self.checkout.invalidateToken(invalidate_token_request)
+
+        self.assertEqual(result.status, "APPROVED")
+        self.assertEqual(result.reason, "00")
+        self.assertEqual(result.message, "The petition has been successfully approved")
+
     @patch("requests.post")
     @RedirectResponseMock.mock_response_decorator("redirect_response_fail_authentication", 401)
     def test_request_fails_bad_request(self, mock_post, mock_response):
@@ -283,3 +300,19 @@ def test_reverse_fails_when_transaction_not_found(self, mock_post, mock_response
         self.assertEqual("FAILED", error_details["status"]["status"])
         self.assertEqual("request_not_valid", error_details["status"]["reason"])
         self.assertEqual("No existe la transacción que busca", error_details["status"]["message"])
+
+    @patch("requests.post")
+    @RedirectResponseMock.mock_response_decorator("invalidate_token_response_fails_token_not_valid", 400)
+    def test_invalidate_fails_when_token_is_not_valid(self, mock_post, mock_response):
+        mock_post.return_value = mock_response
+
+        instrument = Instrument(token=Token(token="not_valid_token", subtoken="test_subtoken"))
+        invalidate_token_request = {"locale": "en_US", "instrument": instrument}
+
+        with self.assertRaises(ClientErrorException) as context:
+            self.checkout.invalidateToken(invalidate_token_request)
+
+        error_details = json.loads(str(context.exception))["error_details"]
+        self.assertEqual("FAILED", error_details["status"]["status"])
+        self.assertEqual("XN", error_details["status"]["reason"])
+        self.assertEqual("The token used is invalid", error_details["status"]["message"])

checkout/tests/mocks/responses/invalidate_token_response_fails_token_not_valid.json

@@ -0,0 +1,8 @@
+{
+    "status": {
+        "status": "FAILED",
+        "reason": "XN",
+        "message": "The token used is invalid",
+        "date": "2022-07-27T14:51:27-05:00"
+    }
+}

checkout/tests/mocks/responses/invalidate_token_response_successful.json

@@ -0,0 +1,8 @@
+{
+    "status": {
+        "status": "APPROVED",
+        "reason": "00",
+        "message": "The petition has been successfully approved",
+        "date": "2022-07-27T14:51:27-05:00"
+    }
+}