Merge pull request #45 from alberto1el/alberto1el-feature-deleteCustomerPaymentProfile

feature delete customer payment profile

Author: delatbabel

src/CIMGateway.php

@@ -46,6 +46,16 @@ public function createCard(array $parameters = array())
         return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMCreateCardRequest', $parameters);
     }
 
+    public function getPaymentProfile(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMGetPaymentProfileRequest', $parameters);
+    }
+
+    public function deleteCard(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMDeletePaymentProfileRequest', $parameters);
+    }
+
     public function authorize(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMAuthorizeRequest', $parameters);

src/Message/CIMDeletePaymentProfileRequest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Omnipay\AuthorizeNet\Message;
+
+/**
+ * Request to delete a customer payment profile for an existing customer and existing payment profile.
+ */
+class CIMDeletePaymentProfileRequest extends CIMAbstractRequest
+{
+    protected $requestType = 'deleteCustomerPaymentProfileRequest';
+
+    public function getData()
+    {
+        $this->validate('customerProfileId', 'customerPaymentProfileId');
+
+        $data = $this->getBaseData();
+        $data->customerProfileId = $this->getCustomerProfileId();
+        $data->customerPaymentProfileId = $this->getCustomerPaymentProfileId();
+
+        return $data;
+    }
+
+    public function sendData($data)
+    {
+        $headers = array('Content-Type' => 'text/xml; charset=utf-8');
+        $data = $data->saveXml();
+        $httpResponse = $this->httpClient->post($this->getEndpoint(), $headers, $data)->send();
+
+        return $this->response = new CIMDeletePaymentProfileResponse($this, $httpResponse->getBody());
+    }
+}

src/Message/CIMDeletePaymentProfileResponse.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Omnipay\AuthorizeNet\Message;
+
+/**
+ * Authorize.Net CIM Delete payment profile Response
+ */
+class CIMDeletePaymentProfileResponse extends CIMAbstractResponse
+{
+    protected $responseType = 'deleteCustomerPaymentProfileResponse';
+}

tests/CIMGatewayIntegrationTest.php

@@ -112,6 +112,41 @@ public function testCustomerAndPaymentProfile()
         );
     }
 
+    public function testPaymentProfileDelete()
+    {
+
+        // Create a customer profile with the specified email (email is the identifier) (to have a deletable payment profile)
+        $email = uniqid('', true) . '@example.com';
+        $cardRef = $this->createCard(array('email' => $email));
+        $cardRef = json_decode($cardRef,true);
+
+        //Delete the recently created payment profile (deletes the payment profile only, not the customer profile)
+        $params = array(
+            'customerProfileId' => $cardRef['customerProfileId'],
+            'customerPaymentProfileId' => $cardRef['customerPaymentProfileId']
+        );
+        $defaults = array(  );
+        $params = array_merge($defaults, $params);
+        $request = $this->gateway->deleteCard($params);
+        $request->setDeveloperMode(true);
+        /* @var $response CIMResponse */
+        $response = $request->send();
+        $this->assertTrue($response->isSuccessful(), 'Should be successful as we have deleted a payment profile');
+
+        /* retrieve the recently deleted payment profile for the customer profile from authorize.net (returns NULL) */
+        $params = array(
+            'customerProfileId' => $cardRef['customerProfileId'],
+            'customerPaymentProfileId' => $cardRef['customerPaymentProfileId']
+        );
+        $defaults = array(  );
+        $params = array_merge($defaults, $params);
+        $request = $this->gateway->getPaymentProfile($params);
+        $request->setDeveloperMode(true);
+        /* @var $response CIMResponse */
+        $response = $request->send();
+        $this->assertNull($response->getCustomerPaymentProfileId(), 'Should be null as we have deleted that payment profile');
+    }
+
     public function testAuthorizeCapture()
     {
         $cardRef = $this->createCard();