olaoluwa-98 / laravel-payant

src/Payant.php

Spacing +87 added lines, -87 removed lines

@@ -62,7 +62,7 @@ 
     */
     public function setBaseUrl()
     {
-        if(Config::get('payant.mode') == 'LIVE')
+        if (Config::get('payant.mode') == 'LIVE')
         {
             $this->base_uri = "https://api.payant.ng";
         }
@@ -82,10 +82,10 @@ 
      */
     private function setRequestOptions()
     {       
-       $authorization_string = 'Bearer '. $this->private_key;
+       $authorization_string = 'Bearer '.$this->private_key;
 
         //Set up Guzzle
-        $this->client = new Client( [
+        $this->client = new Client([
             'base_uri' => $this->base_uri,
             'protocols' => ['https'],
             'headers' => [
@@ -101,7 +101,7 @@ 
      * [getBanks Get Banks and their ids (Nigeria)]
      * @return object [list of banks and their respective bank_ids]
     */
-    public function getBanks(){
+    public function getBanks() {
         return $this->sendRequest('get', '/banks');
     }
     
@@ -113,11 +113,11 @@ 
      * Required fields - 'settlement_bank', 'account_number'
      * @return object
     */
-    public function resolveAccount( array $client_data){
+    public function resolveAccount(array $client_data) {
         // Mandatory fields
         $required_values = ['settlement_bank', 'account_number'];
 
-        if(!array_keys_exist($client_data, $required_values)){
+        if (!array_keys_exist($client_data, $required_values)) {
          throw new RequiredValuesMissing("Missing required values :(");
         }
 
@@ -136,11 +136,11 @@ 
      * Optional - 'address', 'company_name', 'type', 'settlement_bank', 'account_number'
      * @return object
     */
-    public function addClient( array $client_data){
+    public function addClient(array $client_data) {
         // Mandatory fields
         $required_values = ['first_name', 'last_name', 'email', 'phone'];
 
-        if(!array_keys_exist($client_data, $required_values)){
+        if (!array_keys_exist($client_data, $required_values)) {
          throw new RequiredValuesMissing("Missing required values :(");
         }
 
@@ -157,8 +157,8 @@ 
      * @param  string $client_id
      * @return object
     */
-    public function getClient($client_id = null){
-        if(!$client_id){
+    public function getClient($client_id = null) {
+        if (!$client_id) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Client Id");
         }
 
@@ -178,8 +178,8 @@ 
     *        Required fields - 'first_name', 'last_name', 'email', 'phone'
     *        Optional - 'address', 'company_name', 'type', 'settlement_bank', 'account_number'
     */
-    public function editClient( $client_id, array $client_data){
-        if(!$client_id){
+    public function editClient($client_id, array $client_data) {
+        if (!$client_id) {
            throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Client Id");
         }
 
@@ -188,7 +188,7 @@ 
         // Mandatory fields
         $required_values = ['first_name', 'last_name', 'email', 'phone'];
 
-        if(!array_keys_exist($client_data, $required_values)){
+        if (!array_keys_exist($client_data, $required_values)) {
              throw new RequiredValuesMissing("Missing required values :(");
         }
 
@@ -203,8 +203,8 @@ 
      * [deleteClient]
      * @param  string $client_id [description]
      */
-    public function deleteClient($client_id = null){
-        if(!$client_id){
+    public function deleteClient($client_id = null) {
+        if (!$client_id) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Client Id");
         }
 
@@ -227,7 +227,7 @@ 
      * @param string      $fee_bearer  [Mandatory]
      * @param array         $items       [Mandatory]
      */
-    public function addInvoice($client_id, array $client_data, $due_date, $fee_bearer, array $items){
+    public function addInvoice($client_id, array $client_data, $due_date, $fee_bearer, array $items) {
         // Mandatory Client fields
         $required_client_values = ['first_name', 'last_name', 'email', 'phone'];
         
@@ -237,21 +237,21 @@ 
 
         
         // Either the client Id is supplied or a new client data is provided
-        if(!$client_id && !array_keys_exist($client_data, $required_client_values)){
+        if (!$client_id && !array_keys_exist($client_data, $required_client_values)) {
             throw new RequiredValuesMissing("Missing required values :( - Provide client_id or client_data");
         }
 
-        if(!$due_date){
+        if (!$due_date) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Due Date");
         }
 
-        if(!$fee_bearer){
+        if (!$fee_bearer) {
             throw new IsNull("Error Processing Request - Null Fee Bearer");
         }elseif (!in_array($fee_bearer, $valid_fee_bearers)) {
             throw new InvalidFeeBearer("Invalid Fee Bearer - Use either 'account' or 'client'");
         }
 
-        if(!is_array($items)){
+        if (!is_array($items)) {
             throw new IsInvalid("Error Processing Request - Invalid Items");
         }
 
@@ -277,8 +277,8 @@ 
     * @param  string $reference_code [Mandatory - Invoice Reference Code]
     * @return object               
     */
-    public function getInvoice(string $reference_code){
-        if(!$reference_code){
+    public function getInvoice(string $reference_code) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -296,8 +296,8 @@ 
     * @param  string $reference_code [Mandatory - Invoice Reference Code]
     * @return object               
     */
-    public function sendInvoice(string $reference_code = null){
-        if(!$reference_code){
+    public function sendInvoice(string $reference_code = null) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -317,8 +317,8 @@ 
     * @param  string $end    [Format - DD/MM/YYYY]
     * @return object         
     */
-    public function getInvoiceHistory($period, $start = null, $end = null){
-        if(!$period){
+    public function getInvoiceHistory($period, $start = null, $end = null) {
+        if (!$period) {
             throw new RequiredValueMissing("Error Processing Request - period Missing");
         }
 
@@ -338,8 +338,8 @@ 
     * @param  string $reference_code [Mandatory - Invoice Reference Code]
     * @return object                 
     */
-    public function deleteInvoice(string $reference_code){
-        if(!$reference_code){
+    public function deleteInvoice(string $reference_code) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -360,15 +360,15 @@ 
      * @param string      $amount    [Mandatory]
      * @return  object
      */
-    public function addTransfer(array $client_data, string $amount){
+    public function addTransfer(array $client_data, string $amount) {
         // Mandatory Client fields
         $required_client_values = ['first_name', 'last_name', 'email', 'phone', 'settlement_bank', 'account_number'];        
         
-        if(!array_keys_exist($client_data, $required_client_values)){
+        if (!array_keys_exist($client_data, $required_client_values)) {
             throw new RequiredValuesMissing("Missing required values :( - Provide client_data");
         }
 
-        if(!$amount){
+        if (!$amount) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid amount");
         }
 
@@ -391,8 +391,8 @@ 
     * @param  string $reference_code [Mandatory - Transfer Reference Code]
     * @return object               
     */
-    public function getTransfer(string $reference_code){
-        if(!$reference_code){
+    public function getTransfer(string $reference_code) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -413,8 +413,8 @@ 
     * @param  string $end    [Format - DD/MM/YYYY]
     * @return object         
     */
-    public function getTransferHistory($period, $start = null, $end = null){
-        if(!$period){
+    public function getTransferHistory($period, $start = null, $end = null) {
+        if (!$period) {
             throw new RequiredValueMissing("Error Processing Request - period Missing");
         }
 
@@ -435,8 +435,8 @@ 
     * @param  string $reference_code [Mandatory - Invoice Reference Code]
     * @return object                 
     */
-    public function deleteTransfer(string $reference_code){
-        if(!$reference_code){
+    public function deleteTransfer(string $reference_code) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -458,22 +458,22 @@ 
     * @param string $channel        [Mandatory - valid ["Cash", "BankTransfer", "POS", "Cheque"]]
     * @return object
     */
-    public function addPayment(string $reference_code, string $due_date, string $amount, string $channel){
-        if(!$reference_code){
+    public function addPayment(string $reference_code, string $due_date, string $amount, string $channel) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
-        if(!$due_date){
+        if (!$due_date) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid date");
         }
 
-        if(!$amount){
+        if (!$amount) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid amount");
         }
 
         $valid_channels = ["Cash", "BankTransfer", "POS", "Cheque"];
 
-        if(!$channel){
+        if (!$channel) {
             throw new IsNull("Error Processing Request - Null/Invalid amount");
         }elseif (!in_array(ucfirst($channel), $valid_channels)) {
             throw new IsInvalid("Invalid Channel - Cash, BankTransfer, POS or Cheque");
@@ -500,8 +500,8 @@ 
     * @param string $reference_code [Mandatory - Invoice Reference Code]
     * @return object
     */
-    public function getPayment(string $reference_code){
-        if(!$reference_code){
+    public function getPayment(string $reference_code) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -521,8 +521,8 @@ 
     * @param  string $end    [Format - DD/MM/YYYY || Optional if $period !== 'custom']
     * @return object         
     */
-    public function getPaymentHistory(string $period, string $start, string $end){
-        if(!$period){
+    public function getPaymentHistory(string $period, string $start, string $end) {
+        if (!$period) {
             throw new RequiredValueMissing("Error Processing Request - period Missing");
         }
 
@@ -544,12 +544,12 @@ 
     * @param string $passcode [Mandatory - Wallet's passcode]
     * @return object
     */
-    public function addWallet(string $name, string $passcode){
-        if(!$name){
+    public function addWallet(string $name, string $passcode) {
+        if (!$name) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid name");
         }
 
-        if(!$passcode || strlen($passcode) < 6){
+        if (!$passcode || strlen($passcode) < 6) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid passcode/ length");
         }
 
@@ -572,8 +572,8 @@ 
     * @param  string $reference_code [Mandatory - Wallet's Reference Code]
     * @return object 
     */
-    public function getWallet(string $reference_code){
-        if(!$reference_code){
+    public function getWallet(string $reference_code) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -593,16 +593,16 @@ 
     * @param  string $passcode [Mandatory - Wallet's Passcode]    
     * @return object 
     */
-    public function changeWalletPasscode(string $reference_code, string $old_passcode, string $passcode){
-        if(!$reference_code){
+    public function changeWalletPasscode(string $reference_code, string $old_passcode, string $passcode) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
-        if(!$old_passcode){
+        if (!$old_passcode) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid old_passcode");
         }
 
-        if(!$passcode || strlen($passcode) < 6){
+        if (!$passcode || strlen($passcode) < 6) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid passcode");
         }
 
@@ -624,7 +624,7 @@ 
     * [getWallets]
     * @return object
     */
-    public function getWallets(){
+    public function getWallets() {
 
         $url = "/wallets";
 
@@ -640,8 +640,8 @@ 
     * @param  string $reference_code [Mandatory - Wallet's Reference Code]
     * @return object 
     */
-    public function setWalletStatus(string $reference_code){
-        if(!$reference_code){
+    public function setWalletStatus(string $reference_code) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
@@ -663,23 +663,23 @@ 
     * @param  string $passcode [Mandatory - Wallet's Passcode]
     * @return object 
     */
-    public function withdrawFromWallet(string $reference_code, array $client_data, string $amount, string $passcode){
-        if(!$reference_code){
+    public function withdrawFromWallet(string $reference_code, array $client_data, string $amount, string $passcode) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
         // Mandatory fields
         $required_values = ['settlement_bank', 'account_number'];
 
-        if(!array_keys_exist($client_data, $required_values)){
+        if (!array_keys_exist($client_data, $required_values)) {
          throw new RequiredValuesMissing("Missing required values :(");
         }
 
-        if(!$amount){
+        if (!$amount) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid amount");
         }
 
-        if(!$passcode){
+        if (!$passcode) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid passcode");
         }
 
@@ -707,12 +707,12 @@ 
     * @param  string $end    [Format - DD/MM/YYYY]
     * @return object         
     */
-    public function getWalletTransactions(string $reference_code, $period, $start = null, $end = null){
-        if(!$reference_code){
+    public function getWalletTransactions(string $reference_code, $period, $start = null, $end = null) {
+        if (!$reference_code) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
         }
 
-        if(!$period){
+        if (!$period) {
             throw new RequiredValueMissing("Error Processing Request - period Missing");
         }
 
@@ -735,23 +735,23 @@ 
     * @param string $type        [Mandatory - Product type 'product' or 'service']
     * @return object
     */
-    public function addProduct(string $name, string $description, string $unit_cost, string $type){
-        if(!$name){
+    public function addProduct(string $name, string $description, string $unit_cost, string $type) {
+        if (!$name) {
             throw new IsNull("Error Processing Request - Null/Invalid name");
         }
 
-        if(!$description){
+        if (!$description) {
             throw new IsNull("Error Processing Request - Null/Invalid description");
         }
 
-        if(!$unit_cost){
+        if (!$unit_cost) {
             throw new IsNull("Error Processing Request - Null/Invalid unit_cost");
         }
 
         //Validate Product Type
         $valid_product_type = ["product", "service"];
 
-        if(!$type){
+        if (!$type) {
             throw new IsNull("Error Processing Request - Null/Invalid type");
         }elseif (!in_array(strtolower($type), $valid_product_type)) {
             throw new IsInvalid("Invalid Type - Available options: 'product' or 'service'");
@@ -778,8 +778,8 @@ 
     * @param  int $product_id [Mandatory - Product ID]
     * @return object 
     */
-    public function getProduct($product_id){
-        if(!$product_id){
+    public function getProduct($product_id) {
+        if (!$product_id) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid product_id");
         }
 
@@ -798,8 +798,8 @@ 
     * @param  array  $product_data [description]
     * @return object               
     */
-    public function editProduct($product_id, array $product_data){
-        if(!$product_id){
+    public function editProduct($product_id, array $product_data) {
+        if (!$product_id) {
                throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Product Id");
         }
 
@@ -808,7 +808,7 @@ 
 
         $valid_product_type = ["product", "service"];
 
-        if(!$product_type){
+        if (!$product_type) {
             throw new IsNull("Error Processing Request - Null/Invalid type");
         }elseif (!in_array($product_type, $valid_product_type)) {
             throw new IsInvalid("Invalid Type - Available options: 'product' or 'service'");
@@ -819,7 +819,7 @@ 
        // Mandatory fields
        $required_values = ['name', 'description', 'unit_cost', 'type'];
 
-        if(!array_keys_exist($product_data, $required_values)){
+        if (!array_keys_exist($product_data, $required_values)) {
              throw new RequiredValuesMissing("Missing required values :(");
         }
 
@@ -833,7 +833,7 @@ 
     * [getProducts]
     * @return object
     */
-    public function getProducts(){
+    public function getProducts() {
         $url = "/products";
 
         return $this->sendRequest('get', $url);
@@ -847,8 +847,8 @@ 
     * @param $product_id [Mandatory - Product ID]
     * @return object           
     */
-    public function deleteProduct($product_id){
-        if(!$product_id){
+    public function deleteProduct($product_id) {
+        if (!$product_id) {
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Product Id");
         }
 
@@ -866,22 +866,22 @@ 
     * @param array $params         [data to post to request url]
     * @return object
     */
-    public function sendRequest($method, $url, $params=[])
+    public function sendRequest($method, $url, $params = [])
     {
-        try{
-            if (strtolower($method) == 'get'){
+        try {
+            if (strtolower($method) == 'get') {
                 $result = $this->client->request('GET', $url);
-            }elseif (strtolower($method) == 'post'){
+            }elseif (strtolower($method) == 'post') {
                 $result = $this->client->request('POST', $url, $params);
-            }elseif (strtolower($method) == 'put'){
+            }elseif (strtolower($method) == 'put') {
                 $result = $this->client->request('PUT', $url, $params);
-            }elseif (strtolower($method) == 'delete'){
+            }elseif (strtolower($method) == 'delete') {
                 $result = $this->client->request('DELETE', $url);
             }
 
             return cleanResponse($result);
         }
-        catch( Exception $e){
+        catch (Exception $e) {
             throw $e;
         }
     }