ga: add option to add parameter that helps track payments

src/MetisFW/PayPal/DI/PayPalExtension.php

@@ -14,6 +14,7 @@ class PayPalExtension extends CompilerExtension {
    */
   public $defaults = array(
     'currency' => 'CZK',
+    'gaTrackingEnabled' => true
   );
 
   public function loadConfiguration() {
@@ -39,7 +40,8 @@ public function loadConfiguration() {
     $builder->addDefinition($this->prefix('PayPal'))
       ->setClass('MetisFW\PayPal\PayPalContext', array($this->prefix('@apiContext')))
       ->addSetup('setConfig', array($config['sdkConfig']))
-      ->addSetup('setCurrency', array($config['currency']));
+      ->addSetup('setCurrency', array($config['currency']))
+      ->addSetup('setGaTrackingEnabled', array($config['gaTrackingEnabled']));
   }
 
   /**

src/MetisFW/PayPal/Helpers/GaTracking.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MetisFW\PayPal\Helpers;
+
+use Nette\Http\Url;
+use Nette\Object;
+use PayPal\Api\Payment;
+
+class GaTracking extends Object {
+
+  private function __construct() {
+    // nothing
+  }
+
+  public static function addTrackingParameters(Payment $payment) {
+    $redirectUrls = $payment->getRedirectUrls();
+
+    $url = new Url($redirectUrls->getReturnUrl());
+    $url->setQueryParameter('utm_nooverride', 1);
+
+    $redirectUrls->setReturnUrl($url->getAbsoluteUrl());
+    $payment->setRedirectUrls($redirectUrls);
+
+    return $payment;
+  }
+
+}

src/MetisFW/PayPal/PayPalContext.php

@@ -13,6 +13,9 @@ class PayPalContext extends Object {
   /** @var string */
   private $currency;
 
+  /** @var bool */
+  private $gaTrackingEnabled;
+
   /**
    * @param string $clientId
    * @param string $secret
@@ -49,4 +52,18 @@ public function getApiContext() {
     return $this->apiContext;
   }
 
+  /**
+   * @param bool $value
+   */
+  public function setGaTrackingEnabled($value) {
+    $this->gaTrackingEnabled = $value;
+  }
+
+  /**
+   * @return bool
+   */
+  public function isGaTrackingEnabled() {
+    return $this->gaTrackingEnabled;
+  }
+
 }

src/MetisFW/PayPal/Payment/BasePaymentOperation.php

@@ -2,6 +2,7 @@
 
 namespace MetisFW\PayPal\Payment;
 
+use MetisFW\PayPal\Helpers\GaTracking;
 use MetisFW\PayPal\PayPalContext;
 use MetisFW\PayPal\PayPalException;
 use Nette\InvalidArgumentException;
@@ -83,6 +84,10 @@ public function getPayment() {
    * @return Payment
    */
   public function createPayment(Payment $payment) {
+    if($this->context->isGaTrackingEnabled()) {
+      $payment = GaTracking::addTrackingParameters($payment);
+    }
+
     try {
       return $payment->create($this->context->getApiContext());
     }

tests/PayPal/DI/PayPalExtensionTest.phpt

@@ -5,6 +5,7 @@ namespace MetisFWTests\PayPal\DI;
 use MetisFW\PayPal\DI\PayPalExtension;
 use MetisFW\PayPal\Payment\PlainPaymentOperation;
 use MetisFW\PayPal\Payment\SimplePaymentOperation;
+use MetisFW\PayPal\PayPalContext;
 use Nette\Configurator;
 use Tester\Assert;
 use Tester\TestCase;
@@ -21,6 +22,7 @@ class PayPalExtensionTest extends TestCase {
     $config->addConfig(__DIR__.'/../../paypal.config.neon');
 
     $container = $config->createContainer();
+    /** @var PayPalContext $paypal */
     $paypal = $container->getByType('MetisFW\PayPal\PayPalContext');
 
     Assert::notEqual(null, $paypal);
@@ -32,6 +34,8 @@ class PayPalExtensionTest extends TestCase {
     $plainOperationFactory = $container->getByType('MetisFW\PayPal\Payment\PlainPaymentOperationFactory');
     $operation = $plainOperationFactory->create(array());
     Assert::true($operation instanceof PlainPaymentOperation);
+
+    Assert::true($paypal->isGaTrackingEnabled());
   }
 
 }

tests/PayPal/Payment/PaymentOperationTest.phpt

@@ -62,6 +62,27 @@ class PaymentOperationTest extends TestCase {
 
     $result = $operation->createPayment($payment);
     Assert::equal('created', $result->getState());
+    Assert::equal('http://localhost/return', $payment->getRedirectUrls()->getReturnUrl());
+    Assert::notEqual(null, $result->getApprovalLink());
+  }
+
+  public function testCreatePaymentGaTracking() {
+    $credentials = new OAuthTokenCredential($this->config['clientId'], $this->config['secretId']);
+    $apiContext = \Mockery::mock('\PayPal\Rest\ApiContext', array($credentials))->makePartial();
+    $context = new PayPalContext($apiContext);
+    $context->setGaTrackingEnabled(true);
+
+    $operation = new DummyPaymentOperation($context);
+    $payment = $operation->getPayment();
+
+    $redirectUrls = new RedirectUrls();
+    $redirectUrls->setReturnUrl('http://localhost/return');
+    $redirectUrls->setCancelUrl('http://localhost/cancel');
+    $payment->setRedirectUrls($redirectUrls);
+
+    $result = $operation->createPayment($payment);
+    Assert::equal('created', $result->getState());
+    Assert::equal('http://localhost/return?utm_nooverride=1', $payment->getRedirectUrls()->getReturnUrl());
     Assert::notEqual(null, $result->getApprovalLink());
   }