Implemented idempotent requests and corrected disputes unit tests.

Author: lukasz-drzewiecki

mangopay2-python-sdk.pyproj

@@ -31,6 +31,7 @@
     <Compile Include="mangopaysdk\entities\bankaccount.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\entities\idempotencyresponse.py" />
     <Compile Include="mangopaysdk\entities\repudiation.py" />
     <Compile Include="mangopaysdk\entities\disputedocument.py" />
     <Compile Include="mangopaysdk\entities\dispute.py" />
@@ -50,11 +51,14 @@
     <Compile Include="mangopaysdk\entities\entitybase.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="mangopaysdk\entities\settlement.py" />
     <Compile Include="mangopaysdk\tools\apicardpreauthorizations.py" />
     <Compile Include="mangopaysdk\tools\apicards.py" />
     <Compile Include="mangopaysdk\tools\apicardregistrations.py" />
     <Compile Include="mangopaysdk\tools\apidisputes.py" />
+    <Compile Include="mangopaysdk\tools\apiidempotency.py" />
     <Compile Include="mangopaysdk\tools\apievents.py" />
+    <Compile Include="mangopaysdk\tools\filterdisputedocuments.py" />
     <Compile Include="mangopaysdk\tools\sorting.py" />
     <Compile Include="mangopaysdk\tools\apikycdocuments.py" />
     <Compile Include="mangopaysdk\tools\apihooks.py" />
@@ -200,6 +204,7 @@
     <Compile Include="tests\testdisputes.py" />
     <Compile Include="tests\testcardpreauthorizations.py" />
     <Compile Include="tests\testevents.py" />
+    <Compile Include="tests\testidempotency.py" />
     <Compile Include="tests\testkycdocuments.py" />
     <Compile Include="tests\testhooks.py" />
     <Compile Include="tests\testrefunds.py">

mangopaysdk/entities/idempotencyresponse.py

@@ -0,0 +1,12 @@
+from mangopaysdk.entities.entitybase import EntityBase
+
+class IdempotencyResponse(EntityBase):
+    """IdempotencyResponse entity."""
+
+    def __init__(self, id = None):
+        self.StatusCode = None
+        self.ContentLength = None
+        self.ContentType = None
+        self.Date = None
+        self.Resource = None
+        return super(IdempotencyResponse, self).__init__(id)

mangopaysdk/entities/settlement.py

@@ -0,0 +1,8 @@
+from mangopaysdk.entities.transfer import Transfer
+
+
+class Settlement (Transfer):
+
+    def __init__(self, id = None):
+        self.RepudiationId = None
+        return super(Settlement, self).__init__(id)

mangopaysdk/mangopayapi.py

@@ -1,5 +1,5 @@
-from mangopaysdk.tools import apioauth, apiclients, apiusers, apiwallets, apitransfers, apipayins, apipayouts, apievents, apicardpreauthorizations
-from mangopaysdk.tools import apirefunds, apicardregistrations, apicards, apihooks, apikycdocuments, apidisputes
+from mangopaysdk.tools import apioauth, apiclients, apiusers, apiwallets, apitransfers, apipayins, apipayouts, apievents, apicardpreauthorizations
+from mangopaysdk.tools import apirefunds, apicardregistrations, apicards, apihooks, apikycdocuments, apidisputes, apiidempotency
 from mangopaysdk.configuration import Configuration
 from mangopaysdk.tools.storages.authorizationtokenmanager import AuthorizationTokenManager
 
@@ -39,4 +39,5 @@ def __init__(self):
         self.events = apievents.ApiEvents(self)
         self.hooks = apihooks.ApiHooks(self)
         self.kycdocuments = apikycdocuments.ApiKycDocuments(self)
-        self.disputes = apidisputes.ApiDisputes(self)
+        self.disputes = apidisputes.ApiDisputes(self)
+        self.idempotency = apiidempotency.ApiIdempotency(self)

mangopaysdk/tools/apibase.py

@@ -1,4 +1,4 @@
-from mangopaysdk.types.pagination import Pagination
+from mangopaysdk.types.pagination import Pagination
 from mangopaysdk.entities.entitybase import EntityBase
 from mangopaysdk.types.dto import Dto 
 from mangopaysdk.types.money import Money
@@ -16,6 +16,7 @@
 from mangopaysdk.entities.transfer import Transfer
 from mangopaysdk.entities.transaction import Transaction
 from mangopaysdk.entities.transfer import Transfer
+from mangopaysdk.entities.settlement import Settlement
 from mangopaysdk.entities.client import Client
 from mangopaysdk.entities.card import Card
 from mangopaysdk.entities.refund import Refund
@@ -151,7 +152,10 @@ class ApiBase(object):
         'disputes_document_get_for_client' : ('/dispute-documents', 'GET'),
         'disputes_repudiation_get' : ('/repudiations/%s', 'GET'),
 	    'disputes_repudiation_create_settlement' : ('/repudiations/%s/settlementtransfer', 'POST'),
+        
+        'settlement_get' : ('/settlements/%s', 'GET'),
 
+        'idempotency_response_get' : ('/responses/%s', 'GET'),
 
         # These are temporary functions and WILL be removed in the future. 
         # Contact support before using these features or if have any queries.
@@ -208,13 +212,25 @@ def _createObject (self, methodKey, entity, responseClassName = None, entityId =
         param int secondEntityId Releated entity identifier
         return dictionary Response data
         """
+        return self._createObjectIdempotent(None, methodKey, entity, responseClassName, entityId, secondEntityId)
+
+    def _createObjectIdempotent (self, idempotencyKey, methodKey, entity, responseClassName = None, entityId = None, secondEntityId = None):
+        """Create object in API.
+        param string idempotencyKey Idempotency key for this request
+        param string methodKey Key with request data
+        param object entity Entity object
+        param object responseClassName Name of entity class from response
+        param int entityId Entity identifier
+        param int secondEntityId Releated entity identifier
+        return dictionary Response data
+        """
         urlMethod = self._buildUrl(methodKey, entityId, secondEntityId)
 
         if entity != None:
             requestData = self._buildRequestData(entity)
 
         rest = RestTool(self._root, True)
-        response = rest.Request(urlMethod, self._getRequestType(methodKey), requestData)
+        response = rest.RequestIdempotent(idempotencyKey, urlMethod, self._getRequestType(methodKey), requestData)
 
         if responseClassName != None:
             return self._castResponseToEntity(response, responseClassName)

mangopaysdk/tools/apicardpreauthorizations.py

@@ -1,4 +1,4 @@
-from mangopaysdk.tools.apibase import ApiBase
+from mangopaysdk.tools.apibase import ApiBase
 from mangopaysdk.entities.cardpreauthorization import CardPreAuthorization
 
 
@@ -12,7 +12,15 @@ def Create(self, cardPreAuthorization):
         param CardPreAuthorization object to create
         return CardPreAuthorization Object returned from API
         """
-        return self._createObject('preauthorizations_create', cardPreAuthorization, 'CardPreAuthorization')
+        return self.CreateIdempotent(None, cardPreAuthorization)
+
+    def CreateIdempotent(self, idempotencyKey, cardPreAuthorization):
+        """Create new card preauthorization
+        param string idempotencyKey Idempotency key for this request
+        param CardPreAuthorization object to create
+        return CardPreAuthorization Object returned from API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'preauthorizations_create', cardPreAuthorization, 'CardPreAuthorization')
 
     def Get(self, cardPreAuthorizationId):
         """Get card preauthorization

mangopaysdk/tools/apicardregistrations.py

@@ -1,4 +1,4 @@
-from mangopaysdk.tools.apibase import ApiBase
+from mangopaysdk.tools.apibase import ApiBase
 from mangopaysdk.entities.cardregistration import CardRegistration
 from mangopaysdk.entities.temporarypaymentcard import TemporaryPaymentCard
 
@@ -11,7 +11,15 @@ def Create(self, cardRegistration):
         param CardRegistration object to create
         return CardRegistration Object returned from API
         """
-        return self._createObject('cardregistration_create', cardRegistration, 'CardRegistration')
+        return self.CreateIdempotent(None, cardRegistration)
+
+    def CreateIdempotent(self, idempotencyKey, cardRegistration):
+        """Create new card registration
+        param string idempotencyKey Idempotency key for this request
+        param CardRegistration object to create
+        return CardRegistration Object returned from API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'cardregistration_create', cardRegistration, 'CardRegistration')
 
     def Get(self, cardRegistrationId):
         """Get card registration
@@ -37,7 +45,19 @@ def CreateTemporaryPaymentCard(self, paymentCard):
         param TemporaryPaymentCard Temporary payment card to be created
         return TemporaryPaymentCard Object returned from API
         """
-        return self._createObject('temp_paymentcards_create', paymentCard, 'TemporaryPaymentCard')
+        return self.CreateTemporaryPaymentCardIdempotent(None, paymentCard)
+
+    def CreateTemporaryPaymentCardIdempotent(self, idempotencyKey, paymentCard):
+        """WARNING! 
+        This is temporary function and will be removed in future.
+        Contact support before using these features or if have any queries.
+
+        Creates new temporary payment card.
+        param string idempotencyKey Idempotency key for this request
+        param TemporaryPaymentCard Temporary payment card to be created
+        return TemporaryPaymentCard Object returned from API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'temp_paymentcards_create', paymentCard, 'TemporaryPaymentCard')
 
     def GetTemporaryPaymentCard(self, paymentCardId):
         """WARNING! 

mangopaysdk/tools/apidisputes.py

@@ -1,9 +1,10 @@
-from mangopaysdk.tools.apibase import ApiBase
+from mangopaysdk.tools.apibase import ApiBase
 from mangopaysdk.tools.resttool import RestTool
 from mangopaysdk.entities.dispute import Dispute
 from mangopaysdk.entities.transaction import Transaction
 from mangopaysdk.entities.repudiation import Repudiation
 from mangopaysdk.entities.transfer import Transfer
+from mangopaysdk.entities.settlement import Settlement
 
 
 class ApiDisputes(ApiBase):
@@ -68,15 +69,33 @@ def CreateDocument(self, disputeDocument, disputeId):
         param Dispute identifier
         return DisputeDocument object returned from API
         """
-        return self._createObject('disputes_document_create', disputeDocument, 'DisputeDocument', disputeId)
+        return self.CreateDocumentIdempotent(None, disputeDocument, disputeId)
+
+    def CreateDocumentIdempotent(self, idempotencyKey, disputeDocument, disputeId):
+        """Create dispute document.
+        param string idempotencyKey Idempotency key for this request
+        param DisputeDocument entity
+        param Dispute identifier
+        return DisputeDocument object returned from API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'disputes_document_create', disputeDocument, 'DisputeDocument', disputeId)
 
     def CreatePage(self, disputePage, disputeId, disputeDocumentId):
         """Create DisputePage for existing DisputeDocument.
         param DisputePage entity (File should be base64 string)
         param Dispute identifier
         param DisputeDocument identifier
         """
-        return self._createObject('disputes_document_page_create', disputePage, None, disputeId, disputeDocumentId)
+        return self.CreatePageIdempotent(None, disputePage, disputeId, disputeDocumentId)
+
+    def CreatePageIdempotent(self, idempotencyKey, disputePage, disputeId, disputeDocumentId):
+        """Create DisputePage for existing DisputeDocument.
+        param string idempotencyKey Idempotency key for this request
+        param DisputePage entity (File should be base64 string)
+        param Dispute identifier
+        param DisputeDocument identifier
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'disputes_document_page_create', disputePage, None, disputeId, disputeDocumentId)
 
     def ContestDispute(self, contestedFunds, disputeId):
         """Contest dispute.
@@ -148,7 +167,23 @@ def CreateSettlementTransfer(self, settlementTransfer, repudiationId):
         param Repudiation identifier
         return Transfer object returned from API
         """
-        return self._createObject('disputes_repudiation_create_settlement', settlementTransfer, 'Transfer', repudiationId)
+        return self.CreateSettlementTransferIdempotent(None, settlementTransfer, repudiationId)
+
+    def CreateSettlementTransferIdempotent(self, idempotencyKey, settlementTransfer, repudiationId):
+        """Create settlement transfer.
+        param string idempotencyKey Idempotency key for this request
+        param Settlement transfer object
+        param Repudiation identifier
+        return Transfer object returned from API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'disputes_repudiation_create_settlement', settlementTransfer, 'Transfer', repudiationId)
 
     def ResubmitDispute(self, disputeId):
-        return self._saveObject('disputes_save_contest_funds', None, 'Dispute', disputeId)
+        return self._saveObject('disputes_save_contest_funds', None, 'Dispute', disputeId)
+
+    def GetSettlementTransfer(self, settlementId):
+        """Get settlement transfer.
+        param string settlementId SettlementTransfer identifier
+        return Settlement instance returned from API
+        """
+        return self._getObject('settlement_get', settlementId, 'Settlement')

mangopaysdk/tools/apihooks.py

@@ -1,4 +1,4 @@
-from mangopaysdk.tools.apibase import ApiBase
+from mangopaysdk.tools.apibase import ApiBase
 
 class ApiHooks(ApiBase):
     """MangoPay API for hooks and notifications."""
@@ -8,7 +8,15 @@ def Create(self, hook):
         param Hook hook
         return Newly created hook object returned from API
         """
-        return self._createObject('hooks_create', hook, 'Hook')
+        return self.CreateIdempotent(None, hook)
+
+    def CreateIdempotent(self, idempotencyKey, hook):
+        """Creates a new hook.
+        param string idempotencyKey Idempotency key for this request
+        param Hook hook
+        return Newly created hook object returned from API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'hooks_create', hook, 'Hook')
 
     def Get(self, hookId):
         """Gets hook.

mangopaysdk/tools/apiidempotency.py

@@ -0,0 +1,13 @@
+from mangopaysdk.tools.apibase import ApiBase
+from mangopaysdk.tools.resttool import RestTool
+
+
+class ApiIdempotency(ApiBase):
+    """MangoPay API methods for idempotency."""
+
+    def Get(self, idempotencyKey = None):
+        """Get idempotency response object
+        param string Idempotency key
+        return IdempotencyResponse from API
+        """
+        return self._getObject('idempotency_response_get', idempotencyKey)

mangopaysdk/tools/apipayins.py

@@ -1,4 +1,4 @@
-from mangopaysdk.tools.apibase import ApiBase
+from mangopaysdk.tools.apibase import ApiBase
 from mangopaysdk.entities.payin import PayIn
 from mangopaysdk.entities.temporaryimmediatepayin import TemporaryImmediatePayIn
 
@@ -11,9 +11,17 @@ def Create(self, payIn):
         param PayIn payIn object
         return PayIn Object returned from API
         """
+        return self.CreateIdempotent(None, payIn)
+
+    def CreateIdempotent(self, idempotencyKey, payIn):
+        """Create new pay-in object.
+        param string idempotencyKey Idempotency key for this request
+        param PayIn payIn object
+        return PayIn Object returned from API
+        """
         paymentKey = self._getPaymentKey(payIn);
         executionKey = self._getExecutionKey(payIn);
-        return self._createObject('payins_' + paymentKey + '-' + executionKey + '_create', payIn, 'PayIn')
+        return self._createObjectIdempotent(idempotencyKey, 'payins_' + paymentKey + '-' + executionKey + '_create', payIn, 'PayIn')
 
     def Get(self, payInId):
         """Get pay-in object.
@@ -28,7 +36,16 @@ def CreateRefund(self, payInId, refund):
         param Refund refund object to create
         return Refund Object returned by REST API
         """
-        return self._createObject('payins_createrefunds', refund, 'Refund', payInId)
+        return self.CreateRefundIdempotent(None, payInId, refund)
+
+    def CreateRefundIdempotent(self, idempotencyKey, payInId, refund):
+        """Create refund for pay-in object.
+        param string idempotencyKey Idempotency key for this request
+        param type payInId Pay-in identifier
+        param Refund refund object to create
+        return Refund Object returned by REST API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'payins_createrefunds', refund, 'Refund', payInId)
 
     def GetRefund(self, payInId):
         """Get refund for pay-in object.
@@ -46,7 +63,19 @@ def CreateTemporaryImmediatePayIn(self, immediatePayIn):
         param TemporaryImmediatePayIn Immediate pay-in object to create
         return TemporaryImmediatePayIn Object returned from API
         """
-        return self._createObject('temp_immediatepayins_create', immediatePayIn, 'TemporaryImmediatePayIn')
+        return self.CreateTemporaryImmediatePayInIdempotent(None, immediatePayIn)
+
+    def CreateTemporaryImmediatePayInIdempotent(self, idempotencyKey, immediatePayIn):
+        """WARNING! 
+        This is temporary function and will be removed in future.
+        Contact support before using these features or if have any queries.
+
+        Creates new temporary immediate pay-in.
+        param string idempotencyKey Idempotency key for this request
+        param TemporaryImmediatePayIn Immediate pay-in object to create
+        return TemporaryImmediatePayIn Object returned from API
+        """
+        return self._createObjectIdempotent(idempotencyKey, 'temp_immediatepayins_create', immediatePayIn, 'TemporaryImmediatePayIn')
 
     def _getPaymentKey(self, payIn):