Change classes name and add append method to the mobile money status

src/Payswitch/Contracts/MobileMoneyInterface.php

@@ -18,13 +18,13 @@ interface MobileMoneyInterface
      * @param string|int|null  $voucherCode
      * @param array            $curlOptions Additional Curl options to pass to the request
      *
-     * @return MobileMoneyResponseInterface
+     * @return MobileMoneyStatusInterface
      */
     public function pay(
         $amount,
         $msisdn,
         $network,
         $voucherCode = null,
         $curlOptions = []
-    ): MobileMoneyResponseInterface;
+    ): MobileMoneyStatusInterface;
 }

src/Payswitch/Contracts/MobileMoneyResponseInterface.php → src/Payswitch/Contracts/MobileMoneyStatusInterface.php

@@ -2,7 +2,7 @@
 
 namespace Prinx\Payswitch\Contracts;
 
-interface MobileMoneyResponseInterface
+interface MobileMoneyStatusInterface
 {
     /**
      * Has user successfully payed?
@@ -96,4 +96,11 @@ public function getReason();
      * @return int|float
      */
     public function getAmount();
+
+    /**
+     * Data appended to the response by the developer (typically used in the callbacks).
+     *
+     * @return mixed
+     */
+    public function getAppended();
 }

src/Payswitch/MobileMoney.php

@@ -3,7 +3,7 @@
 namespace Prinx\Payswitch;
 
 use Prinx\Payswitch\Contracts\MobileMoneyInterface;
-use Prinx\Payswitch\Contracts\MobileMoneyResponseInterface;
+use Prinx\Payswitch\Contracts\MobileMoneyStatusInterface;
 use function Prinx\Dotenv\env;
 
 class MobileMoney implements MobileMoneyInterface
@@ -59,15 +59,15 @@ class MobileMoney implements MobileMoneyInterface
      * @param string|int|null  $voucherCode
      * @param array            $curlOptions Additional Curl options to pass to the request
      *
-     * @return MobileMoneyResponseInterface
+     * @return MobileMoneyStatusInterface
      */
     public function pay(
         $amount,
         $msisdn,
         $network,
         $voucherCode = null,
         $curlOptions = []
-    ): MobileMoneyResponseInterface {
+    ): MobileMoneyStatusInterface {
         if (isset(self::$networks[$network])) {
             $network = self::$networks[$network];
             $data = $this->prepareData($msisdn, $network, $amount, $voucherCode);
@@ -83,7 +83,7 @@ public function pay(
             $err = 'Unsupported network "'.$network.'"';
         }
 
-        return new MobileMoneyResponse($response ?? null, $err, $data['transaction_id'] ?? null);
+        return new MobileMoneyStatus($response ?? null, $err, $data['transaction_id'] ?? null);
     }
 
     /**

src/Payswitch/MobileMoneyResponse.php → src/Payswitch/MobileMoneyStatus.php

@@ -2,12 +2,12 @@
 
 namespace Prinx\Payswitch;
 
-use Prinx\Payswitch\Contracts\MobileMoneyResponseInterface;
-use Prinx\Payswitch\Traits\GetResponseAttributes;
+use Prinx\Payswitch\Contracts\MobileMoneyStatusInterface;
+use Prinx\Payswitch\Traits\GetStatusAttributes;
 
-class MobileMoneyResponse implements MobileMoneyResponseInterface
+class MobileMoneyStatus implements MobileMoneyStatusInterface
 {
-    use GetResponseAttributes;
+    use GetStatusAttributes;
 
     protected $rawResponse = null;
     protected $response = null;
@@ -16,12 +16,14 @@ class MobileMoneyResponse implements MobileMoneyResponseInterface
     protected $isSuccessful = false;
     protected $isBeingProcessed = false;
     protected $status = 0;
+    protected $appended = null;
 
-    public function __construct($response, $error, $transactionId)
+    public function __construct($response, $error, $transactionId, $appended = null)
     {
         $this->rawResponse = $response;
         $this->response = $response;
         $this->transactionId = $transactionId;
+        $this->appended = $appended;
 
         if ($error) {
             $this->error = $error;
@@ -158,4 +160,9 @@ public function getRawResponse()
     {
         return $this->rawResponse;
     }
+
+    public function getAppended()
+    {
+        return $this->appended;
+    }
 }

src/Payswitch/MobileMoneyResponseCheck.php → src/Payswitch/MobileMoneyStatusChecker.php

@@ -4,7 +4,7 @@
 
 use Exception;
 
-class MobileMoneyResponseCheck
+class MobileMoneyStatusChecker
 {
     const MOMO_RESPONSE_CHECK_ENDPOINT = 'https://[env].theteller.net/v1.1/users/transactions/[transaction_id]/status';
 
@@ -83,7 +83,7 @@ public function check($ids)
             if (!$error) {
                 $response = curl_multi_getcontent($curlHandle);
                 $error = curl_error($curlHandle);
-                $responses['data'][$transactionId] = new MobileMoneyResponse(
+                $responses['data'][$transactionId] = new MobileMoneyStatus(
                     $response,
                     $error,
                     $transactionId
@@ -95,7 +95,7 @@ public function check($ids)
 
         curl_multi_close($multiHandle);
 
-        return new MobileMoneyResponseCheckCallbackHandler($responses);
+        return new MobileMoneyStatusCheckerResponse($responses);
     }
 
     public function formatUrl($transactionId)

src/Payswitch/MobileMoneyResponseCheckCallbackHandler.php → src/Payswitch/MobileMoneyStatusCheckerResponse.php

@@ -7,7 +7,7 @@
 use Prinx\Payswitch\Exceptions\InvalidCurrentResponseKeyException;
 use Txtpay\Support\SlackLog;
 
-class MobileMoneyResponseCheckCallbackHandler
+class MobileMoneyStatusCheckerResponse
 {
     protected $customConditions = [
         'success',
@@ -369,6 +369,44 @@ public function getResponses()
         return $this->responses;
     }
 
+    /**
+     * Append extra data to the responses.
+     *
+     * $toAppend must be in form:
+     *      [
+     *          '012345678' => 'data_to_append_for_this_transaction_id',
+     *          '112345678' => 'data_to_append_for_this_transaction_id',
+     *          '212345678' => 'data_to_append_for_this_transaction_id',
+     *      ]
+     *
+     * The indexes are the transaction ids.
+     *
+     * You can append extra data for only the transaction id that you need.
+     *
+     * @return $this
+     */
+    public function append(array $toAppend)
+    {
+        $this->appended = array_merge($this->appended, $toAppend);
+
+        return $this;
+    }
+
+    public function setAppended(array $toAppend)
+    {
+        $this->appended = $toAppend;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getAppended()
+    {
+        return $this->appended;
+    }
+
     public function getLogger()
     {
         return $this->logger ?? $this->logger = new Log();

src/Payswitch/Traits/GetResponseAttributes.php → src/Payswitch/Traits/GetStatusAttributes.php

@@ -2,7 +2,7 @@
 
 namespace Prinx\Payswitch\Traits;
 
-trait GetResponseAttributes
+trait GetStatusAttributes
 {
     public function getCode()
     {

tests/Unit/MobileMoneyResponseCheckCallbackHandlerTest.php → tests/Unit/MobileMoneyStatusCheckerResponseTest.php

@@ -2,18 +2,19 @@
 
 namespace Tests\Unit;
 
-use Prinx\Payswitch\MobileMoneyResponse;
-use Prinx\Payswitch\MobileMoneyResponseCheckCallbackHandler;
+use Prinx\Payswitch\MobileMoneyStatus;
+use Prinx\Payswitch\MobileMoneyStatusCheckCallbackHandler;
+use Prinx\Payswitch\MobileMoneyStatusCheckerResponse;
 use Tests\TestCase;
 
-class MobileMoneyResponseCheckCallbackHandlerTest extends TestCase
+class MobileMoneyStatusCheckerResponseTest extends TestCase
 {
     public function testCallbackCalledWhenSuccess()
     {
         $responses = [
             'success' => true,
             'data' => [
-                new MobileMoneyResponse(json_encode([
+                new MobileMoneyStatus(json_encode([
                     'code' => '000',
                     'status' => 'approved',
                     'reason' => 'Transaction Successful',
@@ -33,7 +34,7 @@ public function testCallbackCalledOnSuccessCode()
         $responses = [
             'success' => true,
             'data' => [
-                new MobileMoneyResponse(json_encode([
+                new MobileMoneyStatus(json_encode([
                     'code' => '000',
                     'status' => 'approved',
                     'reason' => 'Transaction Successful',
@@ -53,7 +54,7 @@ public function testCallbackCalledWhenFailure()
         $responses = [
             'success' => true,
             'data' => [
-                new MobileMoneyResponse(json_encode([
+                new MobileMoneyStatus(json_encode([
                     'code' => '105',
                     'status' => '',
                     'reason' => 'Transaction',
@@ -70,13 +71,13 @@ public function testCallbackCalledWhenFailure()
 
     public function testCallbackCalledOnFailureCodes()
     {
-        $failureCodes = (new MobileMoneyResponseCheckCallbackHandler([]))->getFailureValues();
+        $failureCodes = (new MobileMoneyStatusCheckerResponse([]))->getFailureValues();
 
         foreach ($failureCodes as  $code) {
             $responses = [
             'success' => true,
             'data' => [
-                new MobileMoneyResponse(json_encode([
+                new MobileMoneyStatus(json_encode([
                     'code' => $code,
                     'status' => '',
                     'reason' => 'Transaction',
@@ -97,7 +98,7 @@ public function testCallbackCalledAlways()
         $responses = [
             'success' => true,
             'data' => [
-                new MobileMoneyResponse(json_encode([
+                new MobileMoneyStatus(json_encode([
                     'code' => '000',
                     'status' => 'approved',
                     'reason' => 'Transaction Successful',
@@ -106,7 +107,7 @@ public function testCallbackCalledAlways()
                     'subscriber_number' => '************1999',
                     'amount' => 1,
                 ]), '', 0),
-                new MobileMoneyResponse(json_encode([
+                new MobileMoneyStatus(json_encode([
                     'code' => '114',
                     'status' => '',
                     'reason' => 'Transaction',
@@ -115,7 +116,7 @@ public function testCallbackCalledAlways()
                     'subscriber_number' => '************1999',
                     'amount' => 1,
                 ]), '', 1),
-                new MobileMoneyResponse(json_encode([
+                new MobileMoneyStatus(json_encode([
                     'code' => '104',
                     'status' => '',
                     'reason' => 'Transaction',
@@ -142,7 +143,10 @@ public function testCallbackCalledWhenCurlError()
 
     public function callbackCalledOn($condition, $responses, $isCustomCondition = false, $expectedCalls = 1)
     {
-        $callbackHandler = $this->getMockBuilder(MobileMoneyResponseCheckCallbackHandler::class)
+        /**
+         * @var \PHPUnit\Framework\MockObject\MockObject|MobileMoneyStatusCheckerResponse
+         */
+        $callbackHandler = $this->getMockBuilder(MobileMoneyStatusCheckCallbackHandler::class)
             ->setConstructorArgs([$responses])
             ->onlyMethods(['runClosure'])
             ->getMock();

tests/Unit/MobileMoneyStatusCheckerTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Tests\Unit;
+
+use Prinx\Payswitch\MobileMoneyStatusChecker;
+use Prinx\Payswitch\MobileMoneyStatusCheckerResponse;
+use Tests\TestCase;
+use function Prinx\Dotenv\addEnv;
+use function Prinx\Dotenv\env;
+
+class MobileMoneyStatusCheckerTest extends TestCase
+{
+    public function testRequest()
+    {
+        $check = (new MobileMoneyStatusChecker())->check([env('TEST_TRANSACTION_ID')]);
+
+        $this->assertInstanceOf(MobileMoneyStatusCheckerResponse::class, $check);
+    }
+
+    public function testFormatUrl()
+    {
+        $expected = 'https://test.theteller.net/v1.1/users/transactions/123456/status';
+
+        addEnv('PAYSWITCH_MOMO_API_ENV', 'test');
+        $transactionId = 123456;
+        $actual = (new MobileMoneyStatusChecker())->formatUrl($transactionId);
+
+        $this->assertEquals($expected, $actual);
+    }
+}