Issue #112 check all mandatory fields are present before Form direct.

Author: judgej

src/Message/AbstractRequest.php

@@ -114,7 +114,7 @@ protected function getAddressData($type = 'Billing')
     {
         $card = $this->getCard();
 
-        // Mapping is Sage Pay name => Omnipay Nname
+        // Mapping is Sage Pay name => Omnipay Name
 
         $mapping = [
             'Firstnames'    => 'FirstName',

src/Message/DirectAuthorizeRequest.php

@@ -47,6 +47,7 @@ protected function getBaseAuthorizeData()
         $data = $this->getBaseData();
 
         $data['Description'] = $this->getDescription();
+
         // Money formatted as major unit decimal.
         $data['Amount'] = $this->getAmount();
         $data['Currency'] = $this->getCurrency();

src/Message/Form/AuthorizeRequest.php

@@ -7,12 +7,14 @@
  */
 
 use Omnipay\SagePay\Message\DirectAuthorizeRequest;
+use Omnipay\Common\Exception\InvalidRequestException;
 
 class AuthorizeRequest extends DirectAuthorizeRequest
 {
     /**
      * Fields accepted by the Form API.
-     * "true" fields are mandatory.
+     * "true" fields are mandatory, "false" fields are optional.
+     * The DeliveryState is conditionally mandatory.
      */
     protected $validFields = [
         'VendorTxCode' => true,
@@ -89,20 +91,43 @@ public function getCryptData()
 
         $data = array_intersect_key($data, $this->validFields);
 
-        // TODO: throw exception if any mandatory fields are missing.
+        // Throw exception if any mandatory fields are missing.
         // We need to catch it here before sending the user to an
-        // unexpected on the gateway site.
+        // generic (and useless) error on the gateway site.
+
+        foreach ($this->validFields as $fieldName => $mandatoryFlag) {
+            if ($mandatoryFlag && ! isset($data[$fieldName])) {
+                throw new InvalidRequestException(sprintf(
+                    'The %s parameter is required',
+                    $fieldName
+                ));
+            }
+        }
+
+        // Two conditional checks on the "state" fields.
+        // We don't check if it is a valid two-character state code.
 
-        // ...
+        if ($data['BillingCountry'] === 'US' && empty ($data['BillingState'])
+            || $data['DeliveryCountry'] === 'US' && empty ($data['DeliveryState'])
+        ) {
+            throw new InvalidRequestException(
+                'Missing state code for billing or shipping address'
+            );
+        }
 
         return $data;
     }
 
     /**
      * Add the Form-specific details to the base data.
+     * @reurn array
      */
     public function getData()
     {
+        $this->validate('currency', 'description');
+
+        // The test mode is included to determine the redirect URL.
+
         return [
             'VPSProtocol' => $this->VPSProtocol,
             'TxType' => $this->getTxType(),
@@ -114,6 +139,8 @@ public function getData()
 
     /**
      * Generate the crypt field from the source data.
+     * @param array $data the name/value pairs to be encrypted
+     * @return string encrypted data
      */
     public function generateCrypt(array $data)
     {

src/Message/Form/Response.php

@@ -20,24 +20,36 @@ class Response extends AbstractResponse implements RedirectResponseInterface, Co
 
     /**
      * Always a redirect, so not yet successful.
+     * @return @inherit
      */
     public function isSuccessful()
     {
         return false;
     }
 
+    /**
+     * @return @inherit
+     */
     public function isRedirect()
     {
         return true;
     }
 
+    /**
+     * @return @inherit
+     */
     public function getRedirectMethod()
     {
         return 'POST';
     }
 
+    /**
+     * @return @inherit
+     */
     public function getRedirectData()
     {
+        // Pull out just these four fields from the data supplied.
+
         return array_intersect_key(
             $this->getData(),
             array_flip([
@@ -61,6 +73,9 @@ public function getRedirectUrl()
         return $this->liveEndpoint;
     }
 
+    /**
+     * @return @inherit
+     */
     public function getTestMode()
     {
         $data =  $this->getData();

tests/FormGatewayTest.php

@@ -17,13 +17,15 @@ public function setUp()
             $this->getHttpRequest()
         );
         $this->gateway->setVendor('example');
+        $this->gateway->setCurrency('EUR');
 
         $this->purchaseOptions = array(
             'amount' => '10.00',
             'transactionId' => '123',
             'card' => $this->getValidCard(),
             'returnUrl' => 'https://www.example.com/return',
             'encryptionKey' => '12345678abcdeabc',
+            'description' => 'Some message',
         );
 
         $this->captureOptions = array(