Merge pull request #140 from omise/tesco-bill-payment

Tesco Lotus Payment Implementation

Block/Checkout/Onepage/Success/TescoAdditionalInformation.php

@@ -0,0 +1,50 @@
+<?php
+namespace Omise\Payment\Block\Checkout\Onepage\Success;
+
+class TescoAdditionalInformation extends \Magento\Framework\View\Element\Template
+{
+ /**
+ * @var \Magento\Checkout\Model\Session
+ */
+ protected $_checkoutSession;
+
+ /**
+ * @param \Magento\Framework\View\Element\Template\Context $context
+ * @param \Magento\Checkout\Model\Session $checkoutSession
+ * @param array $data
+ */
+ public function __construct(
+ \Magento\Framework\View\Element\Template\Context $context,
+ \Magento\Checkout\Model\Session $checkoutSession,
+ array $data = []
+ ) {
+ $this->_checkoutSession = $checkoutSession;
+ parent::__construct($context, $data);
+ }
+
+ /**
+ * Return HTML code with tesco lotus payment infromation
+ *
+ * @return string
+ */
+ protected function _toHtml()
+ {
+ $paymentData = $this->_checkoutSession->getLastRealOrder()->getPayment()->getData();
+ if (!isset($paymentData['additional_information']['payment_type']) || $paymentData['additional_information']['payment_type'] !== 'bill_payment_tesco_lotus') {
+ return parent::_toHtml();
+ }
+ $tescoCodeImageUrl = $paymentData['additional_information']['barcode'];
+
+ if ($tescoCodeImageUrl) {
+ $orderCurrency = $this->_checkoutSession->getLastRealOrder()->getOrderCurrency()->getCurrencyCode();
+
+ $this->addData(
+ [
+ 'tesco_code_url' => $tescoCodeImageUrl,
+ 'order_amount' => number_format($paymentData['amount_ordered'], 2) .' '.$orderCurrency
+ ]
+ );
+ }
+ return parent::_toHtml();
+ }
+}

Gateway/Request/APMBuilder.php

@@ -5,6 +5,7 @@
 use Magento\Payment\Gateway\Helper\SubjectReader;
 use Magento\Payment\Gateway\Request\BuilderInterface;
 use Omise\Payment\Model\Config\Alipay;
+use Omise\Payment\Model\Config\Tesco;
 use Omise\Payment\Model\Config\Internetbanking;
 use Omise\Payment\Observer\InternetbankingDataAssignObserver;
 
@@ -58,6 +59,11 @@ public function build(array $buildSubject)
  self::SOURCE_TYPE => 'alipay'
  ];
  break;
+ case Tesco::CODE:
+ $paymentInfo[self::SOURCE] = [
+ self::SOURCE_TYPE => 'bill_payment_tesco_lotus'
+ ];
+ break;
  case Internetbanking::CODE:
  $paymentInfo[self::SOURCE] = [
  self::SOURCE_TYPE => $method->getAdditionalInformation(InternetbankingDataAssignObserver::OFFSITE)

Gateway/Response/PaymentDetailsHandler.php

@@ -16,5 +16,10 @@ public function handle(array $handlingSubject, array $response)
 
  $payment->setAdditionalInformation('charge_id', $response['charge']->id);
  $payment->setAdditionalInformation('charge_authorize_uri', $response['charge']->authorize_uri);
+ $payment->setAdditionalInformation('payment_type', $response['charge']->source['type']);
+
+ if ($response['charge']->source['type'] === 'bill_payment_tesco_lotus') {
+ $payment->setAdditionalInformation('barcode', $response['charge']->source['references']['barcode']);
+ }
  }
 }

Model/Config/Tesco.php

@@ -0,0 +1,12 @@
+<?php
+namespace Omise\Payment\Model\Config;
+
+use Omise\Payment\Model\Config\Config;
+
+class Tesco extends Config
+{
+ /**
+ * @var string
+ */
+ const CODE = 'omise_offline_tesco';
+}

etc/adminhtml/system.xml

@@ -95,6 +95,21 @@
  <config_path>payment/omise_offsite_alipay/title</config_path>
  </field>
  </group>
+ <group id="omise_offline_tesco" translate="label" sortOrder="190" showInDefault="1" showInWebsite="1" showInStore="1">
+ <label>Enable Tesco Bill Payment Solution</label>
+ <comment>Enable customers to pay for products in Tesco Lotus Stores.</comment>
+ <field id="active" translate="label comment" type="select" sortOrder="200" showInDefault="1" showInWebsite="1" showInStore="1">
+ <label>Enable/Disable</label>
+ <comment>Enable Tesco Bill Payment Solution.</comment>
+ <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+ <config_path>payment/omise_offline_tesco/active</config_path>
+ </field>
+ <field id="title" translate="label" type="text" sortOrder="210" showInDefault="1" showInWebsite="1" showInStore="1">
+ <label>Title</label>
+ <comment>This controls the title which the user sees during checkout.</comment>
+ <config_path>payment/omise_offline_tesco/title</config_path>
+ </field>
+ </group>
  </group>
  </section>
  </system>

etc/config.xml

@@ -42,6 +42,18 @@
  <can_review_payment>1</can_review_payment>
  <payment_action>authorize_capture</payment_action>
  </omise_offsite_alipay>
+
+ <omise_offline_tesco>
+ <active>0</active>
+ <title>Tesco Bill Payment</title>
+ <model>OmiseTescoAdapter</model>
+ <is_gateway>1</is_gateway>
+ <can_initialize>1</can_initialize>
+ <can_use_checkout>1</can_use_checkout>
+ <can_capture>0</can_capture>
+ <can_review_payment>1</can_review_payment>
+ <payment_action>order</payment_action>
+ </omise_offline_tesco>
  </payment>
  </default>
 </config>

etc/di.xml

@@ -37,6 +37,40 @@
  </virtualType>
  <!-- /Value Handler -->
 
+ <!-- Tesco payment solution-->
+ <virtualType name="OmiseTescoAdapter" type="Magento\Payment\Model\Method\Adapter">
+ <arguments>
+ <argument name="code" xsi:type="const">Omise\Payment\Model\Config\Tesco::CODE</argument>
+ <argument name="formBlockType" xsi:type="string">Magento\Payment\Block\Form</argument>
+ <argument name="infoBlockType" xsi:type="string">Magento\Payment\Block\Info</argument>
+ <argument name="valueHandlerPool" xsi:type="object">OmiseAPMTescoValueHandlerPool</argument>
+ <argument name="validatorPool" xsi:type="object">OmiseValidatorPool</argument>
+ <argument name="commandPool" xsi:type="object">OmiseAPMCommandPool</argument>
+ </arguments>
+ </virtualType>
+
+ <!-- Tesco :: Value Handler Pool -->
+ <virtualType name="OmiseAPMTescoValueHandlerPool" type="Magento\Payment\Gateway\Config\ValueHandlerPool">
+ <arguments>
+ <argument name="handlers" xsi:type="array">
+ <item name="default" xsi:type="string">OmiseAPMTescoConfigValueHandler</item>
+ </argument>
+ </arguments>
+ </virtualType>
+
+ <virtualType name="OmiseAPMTescoConfigValueHandler" type="Magento\Payment\Gateway\Config\ConfigValueHandler">
+ <arguments>
+ <argument name="configInterface" xsi:type="object">OmiseAPMTescoConfig</argument>
+ </arguments>
+ </virtualType>
+
+ <virtualType name="OmiseAPMTescoConfig" type="Magento\Payment\Gateway\Config\Config">
+ <arguments>
+ <argument name="methodCode" xsi:type="const">Omise\Payment\Model\Config\Tesco::CODE</argument>
+ </arguments>
+ </virtualType>
+ <!-- /Value Handler -->
+
  <!-- Alipay payment solution-->
  <virtualType name="OmiseAlipayAdapter" type="Magento\Payment\Model\Method\Adapter">
  <arguments>

view/frontend/layout/checkout_index_index.xml

@@ -30,6 +30,9 @@
  </item>
  <item name="omise_offsite_alipay" xsi:type="array">
  <item name="isBillingAddressRequired" xsi:type="boolean">true</item>
+ </item> 
+ <item name="omise_offline_tesco" xsi:type="array">
+ <item name="isBillingAddressRequired" xsi:type="boolean">true</item>
  </item> 
  </item>
  </item>

view/frontend/layout/checkout_onepage_success.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
+ <body>
+ <referenceContainer name="order.success.additional.info">
+ <block class="Omise\Payment\Block\Checkout\Onepage\Success\TescoAdditionalInformation" name="onepage.success.billing_agreement" 
+ template="Omise_Payment::checkout/onepage/success/tesco_additional_info.phtml"/>
+ </referenceContainer>
+ </body>
+</page>

view/frontend/templates/checkout/onepage/success/tesco_additional_info.phtml

@@ -0,0 +1,4 @@
+
+<p><?= __('To finish payment, print the code below and bring it to make payment in any Tesco Lotus Store. Code is valid for the next <b>24 hours only</b>. After that time your order will be canceled.'); ?></p>
+<p style="margin:.5rem 0"><?= $block->escapeHtml(__('Amount to pay'))?>: <strong><?= $block->getOrderAmount();?></b></strong>
+<p><img src="<?= $block->escapeUrl($block->getTescoCodeUrl()) ?>" /></p>

view/frontend/web/js/view/payment/method-renderer/omise-offline-tesco-method.js

@@ -0,0 +1,82 @@
+define(
+ [
+ 'ko',
+ 'Magento_Checkout/js/view/payment/default',
+ 'Magento_Checkout/js/model/full-screen-loader',
+ 'Magento_Checkout/js/action/redirect-on-success',
+ 'Magento_Checkout/js/model/quote',
+ 'Magento_Checkout/js/model/error-processor'
+ ],
+ function (
+ ko,
+ Component,
+ fullScreenLoader,
+ redirectOnSuccessAction,
+ quote,
+ errorProcessor
+ ) {
+ 'use strict';
+
+ return Component.extend({
+ defaults: {
+ template: 'Omise_Payment/payment/offline-tesco-form'
+ },
+
+ isPlaceOrderActionAllowed: ko.observable(quote.billingAddress() != null),
+
+ /**
+ * Get payment method code
+ *
+ * @return {string}
+ */
+ getCode: function() {
+ return 'omise_offline_tesco';
+ },
+
+ /**
+ * Is method available to display
+ *
+ * @return {boolean}
+ */
+ isActive: function() {
+ return true;
+ },
+
+ /**
+ * Handle payment error
+ */
+ handlePaymentError: function(response) {
+ errorProcessor.process(response, self.messageContainer);
+ fullScreenLoader.stopLoader();
+ self.isPlaceOrderActionAllowed(true);
+ },
+
+ /**
+ * Hook the placeOrder function.
+ * Original source: placeOrder(data, event); @ module-checkout/view/frontend/web/js/view/payment/default.js
+ *
+ * @return {boolean}
+ */
+ placeOrder: function(data, event) {
+ var self = this;
+
+ if (event) {
+ event.preventDefault();
+ }
+
+ self.getPlaceOrderDeferredObject()
+ .fail(
+ function(response) {
+ self.handlePaymentError(response);
+ }
+ ).done(
+ function() {
+ redirectOnSuccessAction.execute();
+ }
+ );
+
+ return true;
+ }
+ });
+ }
+);

view/frontend/web/js/view/payment/omise.js

@@ -30,6 +30,13 @@ define(
  }
  );
 
+ rendererList.push(
+ {
+ type: 'omise_offline_tesco',
+ component: 'Omise_Payment/js/view/payment/method-renderer/omise-offline-tesco-method'
+ }
+ );
+
  return Component.extend({});
  }
 );

view/frontend/web/template/payment/offline-tesco-form.html

@@ -0,0 +1,41 @@
+<div class="payment-method"
+ data-bind="css: {'_active': (getCode() == isChecked())}">
+ <div class="payment-method-title field choice">
+ <input type="radio" name="payment[method]" class="radio"
+ data-bind="attr: {
+ 'id': getCode()
+ },
+ value: getCode(),
+ checked: isChecked,
+ click: selectPaymentMethod,
+ visible: isRadioButtonVisible()" />
+ <label data-bind="attr: {'for': getCode()}" class="label">
+ <span data-bind="text: getTitle()"></span>
+ </label>
+ </div>
+ <div class="payment-method-content">
+ <!-- ko foreach: getRegion('messages') -->
+ <!-- ko template: getTemplate() -->
+ <!-- /ko -->
+ <!--/ko-->
+ <div class="payment-method-billing-address">
+ <!-- ko foreach: $parent.getRegion(getBillingAddressFormName()) -->
+ <!-- ko template: getTemplate() -->
+ <!-- /ko -->
+ <!--/ko-->
+ </div>
+ <div class="actions-toolbar">
+ <div class="primary">
+ <button class="action primary checkout" type="submit"
+ disabled="disabled"
+ data-bind="
+ click: placeOrder,
+ attr: {title: $t('Place Order')},
+ css: {disabled: !isPlaceOrderActionAllowed()},
+ enable: (getCode() == isChecked())">
+ <span data-bind="i18n: 'Place Order'"></span>
+ </button>
+ </div>
+ </div>
+ </div>
+</div>