Refactor Handler and add exceptions

.gitignore

@@ -2,6 +2,7 @@
 /docs
 /.phpintel
 composer.phar
+couscous.phar
 
 
 # -- Bower -- #

src/Api/Api.php

@@ -16,15 +16,9 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ClientException;
-use GuzzleHttp\Exception\ConnectException;
-use GuzzleHttp\Exception\TransferException;
-use GuzzleHttp\HandlerStack;
-use GuzzleHttp\Middleware;
 use OVAC\HubtelPayment\Config;
-use OVAC\HubtelPayment\ConfigInterface;
 use OVAC\HubtelPayment\Exception\Handler;
-use Psr\Http\Message\RequestInterface;
-use Psr\Http\Message\ResponseInterface;
+use OVAC\HubtelPayment\Utility\HubtelHandler;
 
 /**
  * Api Class
@@ -73,7 +67,7 @@ public function injectConfig(Config $config)
     /**
      * Change the Default baseUrl defined by hubtel
      *
-     * @param string $baseUrl [description]
+     * @param  string $baseUrl The hubtel Resource Base URL
      * @return self
      */
     public function setBaseUrl($baseUrl)
@@ -142,6 +136,9 @@ public function _options($url = null, array $parameters = [])
     }
     /**
      * {@inheritdoc}
+     *
+     * @throws \RuntimeException
+     * @throws \Handler
      */
     public function execute($httpMethod, $url, array $parameters = [])
     {
@@ -150,15 +147,14 @@ public function execute($httpMethod, $url, array $parameters = [])
                 $response = $this->getClient()->{$httpMethod}($url, ['query' => $parameters]);
 
                 return json_decode((string) $response->getBody(), true);
-            } catch (RequestInterface $e) {
-                throw new ClientException($e->getMessage(), $e);
+            } catch (ClientException $e) {
+                throw new Handler($e);
             }
 
             return;
         }
 
         throw new \RuntimeException('The API requires a configuration instance.');
-
     }
     /**
      * Returns an Http client instance.
@@ -171,50 +167,20 @@ protected function getClient()
 
         return new Client(
             [
-                'base_uri' => $this->baseUrl . $config->getAccountNumber(), 'handler' => $this->createHandler(),
+                'base_uri' => $this->baseUrl . $config->getAccountNumber(),
+                'handler' => $this->createHandler($this->config),
             ]
         );
     }
+
     /**
      * Create the client handler.
      *
-     * @return                               \GuzzleHttp\HandlerStack
-     * @SuppressWarnings(PHPMD.StaticAccess)
+     * @param  \OVAC\HubtelPayment\Config $config
+     * @return \GuzzleHttp\HandlerStack
      */
-    protected function createHandler()
+    protected function createHandler(Config $config)
     {
-        $stack = HandlerStack::create();
-
-        $stack->push(
-            Middleware::mapRequest(
-                function (RequestInterface $request) {
-                    $config = $this->config;
-                    $request = $request->withHeader('User-Agent', 'OVAC-Hubtel-Payment' . $config->getPackageVersion());
-                    $request = $request->withHeader('Authorization', 'Basic ' . base64_encode($config->getClientId() . ':' . $config->getClientSecret()));
-
-                    return $request;
-                }
-            )
-        );
-
-        $stack->push(
-            Middleware::retry(
-                function (
-                    $retries,
-                    RequestInterface $request,
-                    ResponseInterface $response = null,
-                    TransferException $exception = null
-                ) {
-                    return $retries < 3 && ($exception instanceof ConnectException || (
-                        $response && $response->getStatusCode() >= 500
-                    ));
-                },
-                function ($retries) {
-                    return (int) pow(2, $retries) * 1000;
-                }
-            )
-        );
-
-        return $stack;
+        return (new HubtelHandler($config))->createHandler();
     }
 }

src/Api/Transaction/MassAssignable.php

@@ -39,9 +39,10 @@ public function make($data = [])
 
     /**
      * This method is used to mass assign the properties required by the Hubtel ReceiveMoney and SendMoney Api
-     * @param  array $data
+     *
+     * @param   array $data
      * @example ['amount' => 10, 'customer' => ['name' => 'victor', ...], 'clientReference' => 123, 'callbackOnSuccess' => 'url', 'amount' => 10, 'description' => 'some description']
-     * @return self
+     * @return  self
      */
     protected function massAssign($data = [])
     {

src/Api/Transaction/ReceiveMoney.php

@@ -16,6 +16,7 @@
 
 use OVAC\HubtelPayment\Api\Transaction\MassAssignable;
 use OVAC\HubtelPayment\Api\Transaction\Transaction;
+use OVAC\HubtelPayment\Utility\CanCleanParameters;
 
 /**
  * Class ReceiveMoney
@@ -29,6 +30,7 @@ class ReceiveMoney extends Transaction
 {
     use MassAssignable;
     use Transactable;
+    use CanCleanParameters;
 
     /**
      * The 6 digit unique token required to debit a Vodafone
@@ -48,8 +50,30 @@ class ReceiveMoney extends Transaction
      * @var boolean
      */
     protected $feesOnCustomer;
+    /**
+     * {@inheritdoc}
+     */
+    protected $parametersRequired = [
+        'CustomerName',
+        'CustomerMsisdn',
+        'Amount',
+        'PrimaryCallbackURL',
+        'Description',
+        'Channel',
+    ];
+    /**
+     * {@inheritdoc}
+     */
+    protected $parametersOptional = [
+        'CustomerEmail',
+        'SecondaryCallbackURL',
+        'ClientReference',
+        'FeesOnCustomer',
+        'Token',
+    ];
     /**
      * Construct for creating a new instance of the ReceiveMoney Api class
+     *
      * @param array $data An array with configurations for the receive money class
      */
     public function __construct($data = [])
@@ -130,14 +154,6 @@ public function feesOnCustomer($feesOnCustomer)
         return $this->setFeesOnCustomer($feesOnCustomer);
     }
 
-    /**
-     * [run description]
-     * @return [type] [description]
-     */
-    public function run()
-    {
-    }
-
     /**
      * @return string
      */
@@ -177,4 +193,15 @@ public function setFeesOnCustomer($feesOnCustomer)
 
         return $this;
     }
+    /**
+     * The method runs the transaction
+     *
+     * @return
+     */
+    public function run()
+    {
+        if ($this->propertiesPassRequired()) {
+            $this->_get('/receive/mobilemoney', $this->propertiesToArray());
+        }
+    }
 }

src/Api/Transaction/SendMoney.php

@@ -32,6 +32,7 @@ class SendMoney extends Transaction
 
     /**
      * Construct for creating a new instance of the SendMoney Api class
+     *
      * @param array $data An array with configurations for the send money class
      */
     public function __construct($data = [])

src/Api/Transaction/Transaction.php

@@ -87,6 +87,27 @@ class Transaction extends Api
      */
     protected $description;
 
+    /**
+     * Defines an array of required properties
+     *
+     * Names must correspond with properties/parameters on the class
+     * and the properties must accessors defined on the
+     * instance
+     *
+     * @var array
+     */
+    protected $parametersRequired = [];
+    /**
+     * Defines an array of the names of optional properties/parameters names
+     *
+     * Names must correspond with properties on the class
+     * and the properties must accessors defined on the
+     * instance
+     *
+     * @var array
+     */
+    protected $parametersOptional = [];
+
     /**
      * returnes the name of the give customer
      *
@@ -161,6 +182,7 @@ public function setCustomerMsisdn($customerMsisdn)
 
     /**
      * returns the transaction channel (Mobile Network)
+     *
      * @return string
      */
     public function getChannel()
@@ -281,6 +303,7 @@ public function setClientReference($clientReference)
 
     /**
      * gets the description of the transaction.
+     *
      * @return string
      */
     public function getDescription()
@@ -335,6 +358,7 @@ public function setCustomer($data = [])
     }
     /**
      * This method sests a single callback for both the success and Error
+     *
      * @param  string $primaryCallbackURL A url for callbacks from the hubtel server
      * @return self
      */
@@ -350,7 +374,8 @@ public function callback($primaryCallbackURL)
 
     /**
      * This method sets the callbacks for the Hubtel Payments
-     * @param array|string $data
+     *
+     * @param  array|string $data
      * @return self
      */
     public function setCallback($data = [])

src/Config.php

@@ -36,7 +36,7 @@ class Config implements ConfigInterface
      *
      * @var string
      */
-    protected $accoutNumber;
+    protected $accountNumber;
     /**
      * The Hubtel Developer Applicaton Client Id.
      *

src/Exception/BadRequestException.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * @package     OVAC/Hubtel-Payment
+ * @version     1.0.0
+ * @link        https://github.com/ovac/hubtel-payment
+ *
+ * @author      Ariama O. Victor (OVAC) <contact@ovac4u.com>
+ * @link        http://ovac4u.com
+ *
+ * @license     https://github.com/ovac/hubtel-payment/blob/master/LICENSE
+ * @copyright   (c) 2017, Rescope Inc
+ */
+
+namespace OVAC\HubtelPayment\Exception;
+
+/**
+ * Class BadRequestException
+ * throws OVAC\HubtelPayment\Exception\BadRequestException
+ */
+class BadRequestException extends HubtelException
+{
+}