From 5f16e494b49ed9e20c771405f13b26dd80b99195 Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 18 Sep 2017 18:36:42 +1200 Subject: [PATCH 01/10] Self-identify RapidResponse class as transparent redirect. The interface allows for calling functions to check whether the gateway is transparentRedirect. We should respect that here --- src/Message/RapidResponse.php | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/Message/RapidResponse.php b/src/Message/RapidResponse.php index a3b2ccc..ccbd4a6 100644 --- a/src/Message/RapidResponse.php +++ b/src/Message/RapidResponse.php @@ -39,6 +39,16 @@ public function getRedirectData() } } + /** + * Is the response a transparent redirect? + * + * @return boolean + */ + public function isTransparentRedirect() + { + return true; + } + /** * Get a card reference (eWAY Token), for createCard requests. * From 25e7568d9656bdd47aa326094c1e6325251bd66e Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 18 Sep 2017 21:04:36 +1200 Subject: [PATCH 02/10] Add getTransactionId function. eWay has a function to retrieve the merchant (originating website) generated ID but it should implement the standardised Omnipay one per https://github.com/thephpleague/omnipay#successful-response which is ->getTransactionId(); // the reference set by the originating website if available. --- src/Message/RapidResponse.php | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/Message/RapidResponse.php b/src/Message/RapidResponse.php index ccbd4a6..ee65222 100644 --- a/src/Message/RapidResponse.php +++ b/src/Message/RapidResponse.php @@ -63,8 +63,23 @@ public function getCardReference() return null; } + /** + * Get the transaction ID as generated by the merchant website. + * + * @return string + */ + public function getTransactionId() + { + return $this->data['InvoiceNumber']; + } + /** * Get InvoiceNumber - merchant reference for a transaction + * + * @deprecated Omnipay standard interface is to return this when getTransactionId + * is called + * + * @see https://github.com/thephpleague/omnipay#successful-response */ public function getInvoiceNumber() { From da42dd80870827152f9e3e7609d4f544d59b9115 Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 25 Sep 2017 15:52:27 +1300 Subject: [PATCH 03/10] Do not pass expiry details for procesing a token payment. These are not required & have already been passed, so leave out if not available. --- src/Message/RapidDirectAbstractRequest.php | 8 +++-- .../RapidDirectCreateCardRequestTest.php | 33 ++++++++++++++++++- 2 files changed, 38 insertions(+), 3 deletions(-) diff --git a/src/Message/RapidDirectAbstractRequest.php b/src/Message/RapidDirectAbstractRequest.php index e7c7b50..e29e89b 100644 --- a/src/Message/RapidDirectAbstractRequest.php +++ b/src/Message/RapidDirectAbstractRequest.php @@ -62,8 +62,12 @@ protected function getBaseData() if ($this->getCard()) { $data['Customer']['CardDetails'] = array(); $data['Customer']['CardDetails']['Name'] = $this->getCard()->getName(); - $data['Customer']['CardDetails']['ExpiryMonth'] = $this->getCard()->getExpiryDate('m'); - $data['Customer']['CardDetails']['ExpiryYear'] = $this->getCard()->getExpiryDate('y'); + + if ($this->getCard()->getExpiryYear() && $this->getCard()->getExpiryMonth()) { + // Expiry date not required if token present + $data['Customer']['CardDetails']['ExpiryMonth'] = $this->getCard()->getExpiryDate('m'); + $data['Customer']['CardDetails']['ExpiryYear'] = $this->getCard()->getExpiryDate('y'); + } $data['Customer']['CardDetails']['CVN'] = $this->getCard()->getCvv(); if ($this->getEncryptedCardNumber()) { diff --git a/tests/Message/RapidDirectCreateCardRequestTest.php b/tests/Message/RapidDirectCreateCardRequestTest.php index df280b2..e80b7e4 100644 --- a/tests/Message/RapidDirectCreateCardRequestTest.php +++ b/tests/Message/RapidDirectCreateCardRequestTest.php @@ -69,7 +69,38 @@ public function testGetData() $this->assertSame('4111111111111111', $data['Customer']['CardDetails']['Number']); $this->assertSame('12', $data['Customer']['CardDetails']['ExpiryMonth']); } - + + /** + * Test that expiry is optional and not mis-set if token is present. + */ + public function testGetDataNoExpiryTokenPresent() + { + $this->request->initialize(array( + 'apiKey' => 'my api key', + 'password' => 'secret', + 'transactionId' => '999', + 'description' => 'new car', + 'currency' => 'AUD', + 'invoiceReference' => 'INV-123', + 'card' => array( + 'title' => 'Mr.', + 'firstName' => 'John', + 'lastName' => 'Smith', + 'shippingFirstName' => 'Bob', + 'shippingLastName' => 'Mann', + 'shippingAddress1' => 'Level 1', + 'shippingAddress2' => '123 Test Lane', + 'shippingState' => 'NSW', + 'shippingCountry' => 'AU', + 'cardReference' => 'myRef', + ), + )); + + $data = $this->request->getData(); + $this->assertTrue(!isset($data['Customer']['CardDetails']['ExpiryMonth'])); + $this->assertTrue(!isset($data['Customer']['CardDetails']['ExpiryYear'])); + } + public function testSendSuccess() { $this->setMockHttpResponse('RapidDirectCreateCardRequestSuccess.txt'); From 24731f93092be29f144d4f8a4df0af956b897e1d Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 25 Sep 2017 15:54:44 +1300 Subject: [PATCH 04/10] Set TransactionType to MOTO when cvn not available. Cvn is required for an onsite purchase. It is not required when processing a recurring payment. It seems reasonable to assume that if not passed, and we are working with a DirectPayment with a token then it is a recurring payment. Setting to MOTO or Recurring would have the same effect. The practical difference between Recurring & MOTO is not clear and there is not an obvious Omnipay standard to follow so sticking with this assumption for now --- src/Message/RapidDirectPurchaseRequest.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/Message/RapidDirectPurchaseRequest.php b/src/Message/RapidDirectPurchaseRequest.php index b9a187c..ed8003d 100644 --- a/src/Message/RapidDirectPurchaseRequest.php +++ b/src/Message/RapidDirectPurchaseRequest.php @@ -82,6 +82,11 @@ public function getData() $data['Payment']['CurrencyCode'] = $this->getCurrency(); $data['Payment']['InvoiceReference'] = $this->getInvoiceReference(); + if (empty($data['Customer']['CardDetails']['CVN']) && $this->getCardReference()) { + // We have a token and card is not present so treat as MOTO. + $data['TransactionType'] = 'MOTO'; + } + if ($this->getCardReference()) { $data['Method'] = 'TokenPayment'; } else { From e9d755e3a3838335aa32493d90afc6f41b35362a Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 25 Sep 2017 20:42:50 +1300 Subject: [PATCH 05/10] Add support for making a payment when creating a token for Shared & Transparent methods --- src/Message/RapidResponse.php | 5 +++ src/Message/RapidSharedCreateCardRequest.php | 33 ++++++++++++++++++-- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/src/Message/RapidResponse.php b/src/Message/RapidResponse.php index ee65222..67ad353 100644 --- a/src/Message/RapidResponse.php +++ b/src/Message/RapidResponse.php @@ -59,6 +59,11 @@ public function getCardReference() if (isset($this->data['Customer']['TokenCustomerID'])) { return $this->data['Customer']['TokenCustomerID']; } + if (isset($this->data['TokenCustomerID'])) { + // This format appears when creating a card and making a concurrent + // payment using Shared or Transparent redirect methods. + return $this->data['TokenCustomerID']; + } return null; } diff --git a/src/Message/RapidSharedCreateCardRequest.php b/src/Message/RapidSharedCreateCardRequest.php index 8c097ee..6c4fdd0 100644 --- a/src/Message/RapidSharedCreateCardRequest.php +++ b/src/Message/RapidSharedCreateCardRequest.php @@ -14,12 +14,30 @@ */ class RapidSharedCreateCardRequest extends RapidSharedPurchaseRequest { + protected $action; + + /** + * @return string|NULL + */ + public function getAction() + { + return $this->action; + } + + /** + * @param string $action + */ + public function setAction($action) + { + $this->action = $action; + } + public function getData() { $this->validate('returnUrl'); $data = $this->getBaseData(); - $data['Method'] = 'CreateTokenCustomer'; + $data['TransactionType'] = 'Purchase'; $data['RedirectUrl'] = $this->getReturnUrl(); @@ -32,7 +50,18 @@ public function getData() $data['CustomView'] = $this->getCustomView(); $data['Payment'] = array(); - $data['Payment']['TotalAmount'] = 0; + + if ($this->getAction() === 'Purchase') { + $data['Payment']['TotalAmount'] = (int) $this->getAmountInteger(); + $data['Payment']['InvoiceNumber'] = $this->getTransactionId(); + $data['Payment']['InvoiceDescription'] = $this->getDescription(); + $data['Payment']['CurrencyCode'] = $this->getCurrency(); + $data['Payment']['InvoiceReference'] = $this->getInvoiceReference(); + $data['Method'] = 'TokenPayment'; + } else { + $data['Method'] = 'CreateTokenCustomer'; + $data['Payment']['TotalAmount'] = 0; + } return $data; } From a038da1d0417cbfc3b284a505ca49d3a38995e94 Mon Sep 17 00:00:00 2001 From: eileen Date: Tue, 26 Sep 2017 08:57:03 +1300 Subject: [PATCH 06/10] Remove php 5.3 from travis --- .travis.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 7dcfa7a..eb13864 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,6 @@ language: php php: - - 5.3 - 5.4 - 5.5 - 5.6 From ecf58c72e8bd5512a7c2d3de3a6b6b03b645908b Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 2 Oct 2017 13:11:55 +1300 Subject: [PATCH 07/10] Add method to createCard (token) for Rapid transparent redirect gateway --- src/Message/RapidCreateCardRequest.php | 63 ++++++++++++++++++++++++++ src/RapidGateway.php | 5 ++ 2 files changed, 68 insertions(+) create mode 100644 src/Message/RapidCreateCardRequest.php diff --git a/src/Message/RapidCreateCardRequest.php b/src/Message/RapidCreateCardRequest.php new file mode 100644 index 0000000..489521b --- /dev/null +++ b/src/Message/RapidCreateCardRequest.php @@ -0,0 +1,63 @@ +action; + } + + /** + * @param string $action + */ + public function setAction($action) + { + $this->action = $action; + } + + public function getData() + { + $this->validate('returnUrl'); + + $data = $this->getBaseData(); + + $data['TransactionType'] = 'Purchase'; + $data['RedirectUrl'] = $this->getReturnUrl(); + + // Shared page parameters (optional) + $data['CancelUrl'] = $this->getCancelUrl(); + + $data['Payment'] = array(); + + if ($this->getAction() === 'Purchase') { + $data['Payment']['TotalAmount'] = (int) $this->getAmountInteger(); + $data['Payment']['InvoiceNumber'] = $this->getTransactionId(); + $data['Payment']['InvoiceDescription'] = $this->getDescription(); + $data['Payment']['CurrencyCode'] = $this->getCurrency(); + $data['Payment']['InvoiceReference'] = $this->getInvoiceReference(); + $data['Method'] = 'TokenPayment'; + } else { + $data['Method'] = 'CreateTokenCustomer'; + $data['Payment']['TotalAmount'] = 0; + } + + return $data; + } +} diff --git a/src/RapidGateway.php b/src/RapidGateway.php index 48cff5d..872b156 100644 --- a/src/RapidGateway.php +++ b/src/RapidGateway.php @@ -76,4 +76,9 @@ public function refund(array $parameters = array()) { return $this->createRequest('\Omnipay\Eway\Message\RefundRequest', $parameters); } + + public function createCard(array $parameters = array()) + { + return $this->createRequest('\Omnipay\Eway\Message\RapidCreateCardRequest', $parameters); + } } From e516e650a97b531ace1e62ffed1f9de31204dc3c Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 2 Oct 2017 13:40:57 +1300 Subject: [PATCH 08/10] Fix shared Gateway and transparent Redirect to support recurring payments. When processing a recurring payment the directGateway should be used as a 'Continuous' (recurring) authorization as the card is not present at that stage https://github.com/thephpleague/omnipay-common/issues/160 https://github.com/thephpleague/omnipay/pull/466 --- src/RapidGateway.php | 8 ++++++++ src/RapidSharedGateway.php | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/src/RapidGateway.php b/src/RapidGateway.php index 872b156..92625ae 100644 --- a/src/RapidGateway.php +++ b/src/RapidGateway.php @@ -6,6 +6,7 @@ namespace Omnipay\Eway; use Omnipay\Common\AbstractGateway; +use Omnipay\Omnipay; /** * eWAY Rapid Transparent Redirect Gateway @@ -64,6 +65,13 @@ public function setPassword($value) public function purchase(array $parameters = array()) { + if (!empty($parameters['cardTransactionType']) && $parameters['cardTransactionType'] === 'continuous') { + $gateway = Omnipay::create('Eway_RapidDirect'); + $gateway->setApiKey($this->getApiKey()); + $gateway->setPassword($this->getPassword()); + $gateway->setTestMode($this->getTestMode()); + return $gateway->createRequest('\Omnipay\Eway\Message\RapidDirectPurchaseRequest', $parameters); + } return $this->createRequest('\Omnipay\Eway\Message\RapidPurchaseRequest', $parameters); } diff --git a/src/RapidSharedGateway.php b/src/RapidSharedGateway.php index 5f5696a..882549f 100644 --- a/src/RapidSharedGateway.php +++ b/src/RapidSharedGateway.php @@ -6,6 +6,7 @@ namespace Omnipay\Eway; use Omnipay\Common\AbstractGateway; +use Omnipay\Omnipay; /** * eWAY Rapid Responsive Shared Page Gateway @@ -61,6 +62,13 @@ public function setPassword($value) public function purchase(array $parameters = array()) { + if (!empty($parameters['cardTransactionType']) && $parameters['cardTransactionType'] === 'continuous') { + $gateway = Omnipay::create('Eway_RapidDirect'); + $gateway->setApiKey($this->getApiKey()); + $gateway->setPassword($this->getPassword()); + $gateway->setTestMode($this->getTestMode()); + return $gateway->createRequest('\Omnipay\Eway\Message\RapidDirectPurchaseRequest', $parameters); + } return $this->createRequest('\Omnipay\Eway\Message\RapidSharedPurchaseRequest', $parameters); } From e9c1c72b6ff54441ef3a41ad0d2a24244dffd75c Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 16 Oct 2017 12:14:41 +1300 Subject: [PATCH 09/10] Honour purchase action for createCardRequest. Eway does not natively allow you to make a concurrent purchase with a card creation for the Direct gateway (only). I think we should be honouring this pattern (which is used on other gateways) and we can do it by internally doing the purchase when the card is created. --- src/Message/AbstractRequest.php | 17 +++++++++ src/Message/RapidCreateCardRequest.php | 18 ---------- src/Message/RapidDirectCreateCardRequest.php | 24 ++++++++++++- src/Message/RapidDirectCreateCardResponse.php | 35 ++++++++++++++++--- 4 files changed, 71 insertions(+), 23 deletions(-) diff --git a/src/Message/AbstractRequest.php b/src/Message/AbstractRequest.php index ffcb047..75fd802 100644 --- a/src/Message/AbstractRequest.php +++ b/src/Message/AbstractRequest.php @@ -16,6 +16,7 @@ abstract class AbstractRequest extends \Omnipay\Common\Message\AbstractRequest { protected $liveEndpoint = 'https://api.ewaypayments.com'; protected $testEndpoint = 'https://api.sandbox.ewaypayments.com'; + protected $action; public function getApiKey() { @@ -84,6 +85,22 @@ public function setInvoiceReference($value) return $this->setParameter('invoiceReference', $value); } + /** + * @return string|NULL + */ + public function getAction() + { + return $this->action; + } + + /** + * @param string $action + */ + public function setAction($action) + { + $this->action = $action; + } + protected function getBaseData() { $data = array(); diff --git a/src/Message/RapidCreateCardRequest.php b/src/Message/RapidCreateCardRequest.php index 489521b..bbd7095 100644 --- a/src/Message/RapidCreateCardRequest.php +++ b/src/Message/RapidCreateCardRequest.php @@ -14,24 +14,6 @@ */ class RapidCreateCardRequest extends RapidPurchaseRequest { - protected $action; - - /** - * @return string|NULL - */ - public function getAction() - { - return $this->action; - } - - /** - * @param string $action - */ - public function setAction($action) - { - $this->action = $action; - } - public function getData() { $this->validate('returnUrl'); diff --git a/src/Message/RapidDirectCreateCardRequest.php b/src/Message/RapidDirectCreateCardRequest.php index 7894242..26b66f1 100644 --- a/src/Message/RapidDirectCreateCardRequest.php +++ b/src/Message/RapidDirectCreateCardRequest.php @@ -5,6 +5,9 @@ namespace Omnipay\Eway\Message; +use Omnipay\Eway\RapidDirectGateway; +use Omnipay\Omnipay; + /** * eWAY Rapid Direct Create Card Request * @@ -78,6 +81,25 @@ public function sendData($data) ->setAuth($this->getApiKey(), $this->getPassword()) ->send(); - return $this->response = new RapidDirectCreateCardResponse($this, $httpResponse->json()); + $this->response = new RapidDirectCreateCardResponse($this, $httpResponse->json()); + + if ($this->getAction() === 'Purchase' && $this->response->isSuccessful()) { + /** @var RapidDirectGateway $purchaseGateway */ + $purchaseGateway = Omnipay::create('Eway_RapidDirect'); + $purchaseGateway->setApiKey($this->getApiKey()); + $purchaseGateway->setPassword($this->getPassword()); + $purchaseGateway->setTestMode($this->getTestMode()); + $purchaseResponse = $purchaseGateway->purchase(array( + 'amount' => $this->getAmount(), + 'currency' => $this->getCurrency(), + 'description' => $this->getDescription(), + 'transactionId' => $this->getTransactionId(), + 'card' => $this->getCard(), + 'cardReference' => $this->response->getCardReference(), + ))->send(); + $this->response->setPurchaseResponse($purchaseResponse); + } + + return $this->response; } } diff --git a/src/Message/RapidDirectCreateCardResponse.php b/src/Message/RapidDirectCreateCardResponse.php index 2648620..5441049 100644 --- a/src/Message/RapidDirectCreateCardResponse.php +++ b/src/Message/RapidDirectCreateCardResponse.php @@ -2,20 +2,47 @@ /** * eWAY Rapid Direct Create Card Response */ - + namespace Omnipay\Eway\Message; +use Omnipay\SecurePay\Message\DirectPostCompletePurchaseResponse; + /** * eWAY Rapid Direct Create Card Response - * - * This is the response class for Rapid Direct when creating + * + * This is the response class for Rapid Direct when creating * or updating a card * */ class RapidDirectCreateCardResponse extends RapidResponse { + /** + * @var DirectPostCompletePurchaseResponse + */ + protected $purchaseResponse; + + /** + * @return DirectPostCompletePurchaseResponse + */ + public function getPurchaseResponse() + { + return $this->purchaseResponse; + } + + /** + * @param DirectPostCompletePurchaseResponse $purchaseResponse + */ + public function setPurchaseResponse($purchaseResponse) + { + $this->purchaseResponse = $purchaseResponse; + } + public function isSuccessful() { - return $this->data['ResponseMessage'] == 'A2000'; + if (!$this->getPurchaseResponse()) { + return $this->data['ResponseMessage'] == 'A2000'; + } else { + return ($this->data['ResponseMessage'] == 'A2000' && $this->purchaseResponse->isSuccessful()); + } } } From bb28152c5bdfc0a11a41a74e1bd06ef4c81dd88f Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 16 Oct 2017 12:37:35 +1300 Subject: [PATCH 10/10] Add editorConfig file --- .editorConfig | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .editorConfig diff --git a/.editorConfig b/.editorConfig new file mode 100644 index 0000000..cd8eb86 --- /dev/null +++ b/.editorConfig @@ -0,0 +1,15 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false