Tweak redirect method

Author: barryvdh

UPGRADE.md

@@ -1,3 +1,6 @@
+## Upgrade apps from 2.x to 3.x
+ - The `redirect()` method no calls `exit()` after sending the content. This is up to the developer now.
+
 ## Upgrade Gateways from 2.x to 3.x
 
 The primary difference is the HTTP Client. We are now using HTTPlug (http://httplug.io/) but rely on our own interface.

src/Omnipay/Common/Message/AbstractResponse.php

@@ -8,7 +8,6 @@
 use Omnipay\Common\Exception\RuntimeException;
 use Symfony\Component\HttpFoundation\RedirectResponse as HttpRedirectResponse;
 use Symfony\Component\HttpFoundation\Response as HttpResponse;
-use Symfony\Component\HttpFoundation\Response;
 
 /**
  * Abstract Response
@@ -158,20 +157,46 @@ public function getTransactionId()
  return null;
  }
 
+ /**
+ * Gets the redirect target url.
+ *
+ * @return string
+ */
+ public function getRedirectUrl()
+ {
+ return null;
+ }
+
+ /**
+ * Get the required redirect method (either GET or POST).
+ *
+ * @return string
+ */
+ public function getRedirectMethod(){
+ return 'GET';
+ }
+
+ /**
+ * Gets the redirect form data array, if the redirect method is POST.
+ *
+ * @return array
+ */
+ public function getRedirectData()
+ {
+ return [];
+ }
+
  /**
  * Automatically perform any required redirect
  *
  * This method is meant to be a helper for simple scenarios. If you want to customize the
  * redirection page, just call the getRedirectUrl() and getRedirectData() methods directly.
  *
- * @codeCoverageIgnore
- *
  * @return void
  */
  public function redirect()
  {
  $this->getRedirectResponse()->send();
- exit;
  }
 
  /**
@@ -183,7 +208,10 @@ public function getRedirectResponse()
  throw new RuntimeException('This response does not support redirection.');
  }
 
- /** @var $this RedirectResponseInterface */
+ if (empty($this->getRedirectUrl())) {
+ throw new RuntimeException('The given redirectUrl cannot be empty.');
+ }
+
  if ('GET' === $this->getRedirectMethod()) {
  return HttpRedirectResponse::create($this->getRedirectUrl());
  } elseif ('POST' === $this->getRedirectMethod()) {

tests/Omnipay/Common/Message/AbstractResponseTest.php

@@ -55,6 +55,33 @@ public function testGetRedirectResponseNotSupported()
  $this->response->getRedirectResponse();
  }
 
+ /**
+ * @expectedException \Omnipay\Common\Exception\RuntimeException
+ * @expectedExceptionMessage The given redirectUrl cannot be empty.
+ */
+ public function testGetRedirectResponseUrlNotEmpty()
+ {
+ $this->response = m::mock('\Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse')->makePartial();
+ $this->response->shouldReceive('getRedirectUrl')->once()->andReturn(null);
+
+ $this->response->getRedirectResponse();
+ }
+
+ /**
+ * @runInSeparateProcess
+ */
+ public function testRedirect()
+ {
+ $this->response = m::mock('\Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse')->makePartial();
+ $this->response->shouldReceive('getRedirectMethod')->andReturn('GET');
+
+ ob_start();
+ $this->response->redirect();
+ $body = ob_get_clean();
+
+ $this->assertContains('Redirecting to https://example.com/redirect?a=1&b=2', $body);
+ }
+
  public function testGetRedirectResponseGet()
  {
  $this->response = m::mock('\Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse')->makePartial();