Better payment error handling and improved payment config

config/config.yml.dist

@@ -11,6 +11,9 @@ sq_sandbox_location_id: CBASEC73OwdNXqWhk6o3SKFwsvUgAQ
 
 bookings_email: bookings@thegrandexpedition.co.uk
 
-testmode: true
-
+url:
+  basket: /basket
+  checkout: /checkout
+  complete: /order-complete
 
+testmode: false

src/SquarepayExtension.php

@@ -56,12 +56,15 @@ class SquarepayExtension extends SimpleExtension
 		}
 
 		$app['twig.runtime.square'] = $app->share(function ($app) {
-			return new Twig\SquareTwigRuntime(
+			$runtime = new Twig\SquareTwigRuntime(
 				$app['square.apiClient'],
 				$app['twig'],
 				$this->getConfig(),
-				$app['session']->get('basket')
+				$app['session']->get('basket'),
+				$app['session']->get('sqerror')->errors ?? null
 			);
+			$app['session']->set('sqerror', null); // Remove previous payment processing errors, after passing them into the runtime
+			return $runtime;
 		});
 
 		$app['twig.runtimes'] = $app->extend(
@@ -77,10 +80,12 @@ class SquarepayExtension extends SimpleExtension
 
 	protected function registerFrontendRoutes(ControllerCollection $collection)
 	{
-        $collection->post ('/basket/add',    [$this, 'basketAdd']);
-        $collection->post ('/basket/remove', [$this, 'basketRemove']);
-        $collection->post ('/basket/update', [$this, 'basketUpdate']);
-        $collection->match('/basket/clear',  [$this, 'basketClear']);
+		$config = $this->getConfig();
+		$basketUrl = $config['url']['basket'];
+		$collection->post ($basketUrl.'/add',    [$this, 'basketAdd']);
+        $collection->post ($basketUrl.'/remove', [$this, 'basketRemove']);
+        $collection->post ($basketUrl.'/update', [$this, 'basketUpdate']);
+        $collection->match($basketUrl.'/clear',  [$this, 'basketClear']);
 		$collection->match('/process-square', [$this, 'processSquarePaymentResponse']);
 	}
 	
@@ -148,8 +153,8 @@ class SquarepayExtension extends SimpleExtension
 				'squid'		=> $squid
 			];
 		}
-        $app['session']->set('basket', $basket);
-        return new RedirectResponse('/basket');
+		$app['session']->set('basket', $basket);
+        return $this->basketRedirectResponse();
 	}
 
 	public function basketUpdate(Application $app, Request $request)
@@ -170,7 +175,7 @@ class SquarepayExtension extends SimpleExtension
 			} 
 		}
         $app['session']->set('basket', $basket);
-        return new RedirectResponse('/basket');
+        return $this->basketRedirectResponse();
 	}
 
 	public function basketRemove(Application $app, Request $request)
@@ -180,13 +185,13 @@ class SquarepayExtension extends SimpleExtension
 		$key	= substr(md5($sku), 0, 10);
 		unset($basket[$key]);
         $app['session']->set('basket', $basket);
-        return new RedirectResponse('/basket');
+        return $this->basketRedirectResponse();
 	}
 
 	public function basketClear(Application $app)
 	{
         $app['session']->set('basket', []);
-        return new RedirectResponse('/basket');
+        return $this->basketRedirectResponse();
 	}
 
 	// -----------------------------------------------------------------------------------------------------------------
@@ -206,10 +211,14 @@ class SquarepayExtension extends SimpleExtension
 		$locationId = $testmode ? $config['sq_sandbox_location_id'] : $config['sq_location_id'];
 		$apiClient = $testmode ? $app['square.apiSandboxClient'] : $app['square.apiClient'];
 
+		// Log the attempt
+		$message = 'Square: Payment attempt by '.$name.' - '.$email;
+		$app['logger.system']->info($message, ['event' => 'extension']);
+
 		// Create the order
 		// NOTE: The Orders API has sandbox support for ad-hoc items only. There is no sandbox support for orders built from Catalog items.
 		$orderId = null;
-		$basket	= $app['session']->get('basket');
+		$basket	= $app['session']->get('basket') ?? [];
 		$lineItems = [];
 		foreach($basket as $line) {
 			$sqitem = new \SquareConnect\Model\CreateOrderRequestLineItem;
@@ -231,17 +240,15 @@ class SquarepayExtension extends SimpleExtension
 		try {
 			$ordersApi = new \SquareConnect\Api\OrdersApi($apiClient);
 			$response = $ordersApi->createOrder($locationId, $request);
-			// dump($response);
 		}
 		catch (Exception $e) {
-			// TODO: Add better error handling
-			echo '<pre>';
-			echo 'Exception when calling OrdersApi->createOrder:', $e->getMessage(), PHP_EOL;
-			echo '</pre>';
-			exit;
+			$responseBody = $e->getResponseBody();
+			$message = 'Square: '.json_encode($responseBody);
+			$app['logger.system']->notice($message, ['event' => 'extension']);
+			$app['session']->set('sqerror', $responseBody);
+			return $this->checkoutRedirectResponse();
 		}
 		$orderId = $response['order']['id'];
-		// dump($orderId);
 
 		// Build transaction request
 		$buyerInfo = [
@@ -266,22 +273,29 @@ class SquarepayExtension extends SimpleExtension
 			'note' => $booker.' on '.$date
 		];
 
-		// $chargeRequest = new \SquareConnect\Model\ChargeRequest();
-		// $chargeRequest->setOrderId($orderId); // Link an order ID
-
 		$tranactionRequest = array_merge($buyerInfo, $paymentInfo, $referenceInfo);
 		$transactionsApi = new \SquareConnect\Api\TransactionsApi($apiClient);
 		try {
 			$response = $transactionsApi->charge($locationId, $tranactionRequest);
 		} catch (\SquareConnect\ApiException $e) {
-			return new RedirectResponse('/order-problem');
+			$responseBody = $e->getResponseBody();
+			$message = 'Square: '.json_encode($responseBody);
+			$app['logger.system']->notice($message, ['event' => 'extension']);
+			$app['session']->set('sqerror', $responseBody);
+			return $this->checkoutRedirectResponse();
 		}
+		$message = 'Square: '.json_encode($response);
+		$app['logger.system']->info($message, ['event' => 'extension']);
 
 		$this->sendConfirmationEmail($app, $name, $email, $booker, $date, $basket, $basketTotal);
 		$app['session']->set('basket', []);
-        return new RedirectResponse('/order-complete');
+		$config = $this->getConfig();
+        return new RedirectResponse($config['url']['complete']);
 	}
 
+	// -----------------------------------------------------------------------------------------------------------------
+	// Order Confirmation Email
+
 	private function sendConfirmationEmail($app, $name, $email, $booker, $date, $basket, $basketTotal)
 	{
 		$body = $app['twig']->render('@Squarefront/email-confirmation.twig', [
@@ -308,4 +322,19 @@ class SquarepayExtension extends SimpleExtension
 		}
 	}
 
+	// -----------------------------------------------------------------------------------------------------------------
+	// URL helper functions
+
+	private function basketRedirectResponse()
+	{
+		$config = $this->getConfig();
+        return new RedirectResponse($config['url']['basket']);
+	}
+
+	private function checkoutRedirectResponse()
+	{
+		$config = $this->getConfig();
+        return new RedirectResponse($config['url']['checkout']);
+	}
+
 }

src/Twig/SquareTwigRuntime.php

@@ -14,12 +14,13 @@ class SquareTwigRuntime
 {
     private $apiClient;
 
-	public function __construct($apiClient, $twig, $config, $basket)
+	public function __construct($apiClient, $twig, $config, $basket, $error)
 	{
 		$this->apiClient = $apiClient;
 		$this->twig = $twig;
 		$this->config = $config;
-		$this->basket = $basket;
+		$this->basket = $basket ?? [];
+		$this->error = $error;
 	}
 
 	public function getCatalog()
@@ -61,7 +62,10 @@ class SquareTwigRuntime
 	}
 	
 	public function displayCCForm() {
-		$context = $this->config;
+		$context = [
+			'config' => $this->config,
+			'error' => $this->error
+		];
 		return $this->twig->render('@Squarefront/cardentryform.twig', $context);
 	}
 

templates/frontend/cardentryform.twig

@@ -2,11 +2,15 @@
 <script type="text/javascript" src="/extensions/vendor/ginger/squarepay/sq-paymentform.js?v=2018-10-30-a"></script>
 <script>
 // For sq-paymentform.js	
-var applicationId = '{{ testmode ? sq_sandbox_app_id : sq_app_id }}';
-var locationId = '{{ testmode ? sq_sandbox_location_id : sq_location_id }}';
+var applicationId = '{{ config.testmode ? config.sq_sandbox_app_id : config.sq_app_id }}';
+var locationId = '{{ config.testmode ? config.sq_sandbox_location_id : config.sq_location_id }}';
 </script>
 
-<div id="card-error-area" class="hidden"></div>
+<div id="card-error-area" class="{{ error | length ?: 'hidden' }}">
+	{% for err in error %}
+		{{ err.detail }} <small>( {{ err.code  | lower }} )</small><br>
+	{% endfor %}
+</div>
 
 <div id="cc-form">
 	<form id="nonce-form" novalidate action="/process-square" method="post">
@@ -21,7 +25,7 @@ var locationId = '{{ testmode ? sq_sandbox_location_id : sq_location_id }}';
 	</div>
 	<div class="cc-row">
 		<label>Date of Booking</label>
-		<input type="date" name="date" placeholedr="dd/mm/yy">
+		<input type="date" name="date" placeholedr="dd/mm/yy" min="{{ 'now' | date('Y-m-d') }}" max="2019-12-31">
 	</div>
 	<div class="cc-row">
 		<label>Name of Booker</label>