General Update: Enhanced Features and Improved Performance

.docker/.gitpod.Dockerfile

@@ -0,0 +1,3 @@
+FROM gitpod/workspace-full
+
+RUN sudo install-packages php-xdebug

.github/workflows/change-review.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.4, 8.1, 8.2]
+        php: [7.4, 8.1, 8.2, 8.3]
 
     env:
       XDEBUG_MODE: coverage
@@ -48,17 +48,13 @@ jobs:
       - name: Install dependencies
         run: composer install --prefer-dist --no-progress
 
-      - name: 'Create env file'
-        run: |
-          touch .env
-          echo PUBLIC_KEY=${PUBLIC_KEY} >> .env
-          echo SECRET_KEY=${SECRET_KEY} >> .env
-          echo ENCRYPTION_KEY=${ENCRYPTION_KEY} >> .env
-          echo ENV=${ENV} >> .env
-          ls -a ${{ github.workspace }}
-
       - name: run unit tests and coverage scan
         run: ./vendor/bin/pest --coverage --min=20 --coverage-clover ./coverage.xml
+        env:
+          PUBLIC_KEY: ${{ secrets.PUBLIC_KEY }}
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+          ENCRYPTION_KEY: ${{ secrets.ENCRYPTION_KEY }}
+          ENV: ${{ secrets.ENV }}
 
       - name: Upload to Codecov
         uses: codecov/codecov-action@v2

.gitpod.yml

@@ -0,0 +1,15 @@
+# This configuration file was automatically generated by Gitpod.
+# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
+# and commit this file to your remote git repository to share the goodness with others.
+
+# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart
+
+image:
+    file: .docker/.gitpod.Dockerfile
+
+tasks:
+  - init: make
+
+vscode:
+    extensions:
+        - felixfbecker.php-debug

Makefile

@@ -1,8 +1,15 @@
 .PHONY: init
-test:
+check:
 	@echo "Installing dependencies..."
 	@composer install
 	@echo "Installing dependencies... Done"
 	@./vendor/bin/pest --coverage --min=0 --coverage-clover ./coverage.xml
 
 
+test:
+	@./vendor/bin/pest --coverage --min=0 --coverage-clover ./coverage.xml
+
+debug:
+	XDEBUG_MODE=coverage ./vendor/bin/pest --coverage --coverage-html .log
+
+

examples/card.php

@@ -4,7 +4,26 @@
 
 use Flutterwave\Util\AuthMode;
 use Flutterwave\Util\Currency;
-\Flutterwave\Flutterwave::bootstrap();
+use Flutterwave\Config\ForkConfig;
+use Dotenv\Dotenv;
+// custom config.
+
+if(!file_exists( '.env' )) {
+    $dotenv = Dotenv::createImmutable(__DIR__."/../"); 
+} else {
+    $dotenv = Dotenv::createImmutable(__DIR__."/");
+}
+
+$dotenv->safeLoad();
+
+$config = ForkConfig::setUp(
+    $_ENV['SECRET_KEY'],
+    $_ENV['PUBLIC_KEY'],
+    $_ENV['ENV'],
+    $_ENV['ENCRYPTION_KEY']
+);
+
+\Flutterwave\Flutterwave::bootstrap($config);
 
 try {
 
@@ -48,6 +67,8 @@
     $data['customer'] = $customerObj;
     $payload  = $cardpayment->payload->create($data);
 
+
+
     if(!empty($_REQUEST))
     {
         $request = $_REQUEST;
@@ -59,7 +80,7 @@
 
         if(isset($request['make'])){
             $result = $cardpayment->initiate($payload);
-
+            dd($cardpayment);
             if($result['mode'] === AuthMode::PIN){
                 $instruction = $result['instruction'];
                 require __DIR__."/view/form/pin.php";

phpunit.xml.dist

@@ -19,6 +19,12 @@
     <include>
         <directory suffix=".php">./src</directory>
     </include>
+    <exclude>
+        <directory suffix=".php">./vendor</directory>
+        <directory suffix=".js">./vendor</directory>
+        <directory suffix=".xml">./vendor</directory>
+        <file>tests/bootstrap.php</file>
+    </exclude>
     <report>
         <clover outputFile="coverage.xml" />
     </report>

processPayment.php

@@ -9,15 +9,33 @@
 use Flutterwave\EventHandlers\ModalEventHandler as PaymentHandler;
 use Flutterwave\Flutterwave;
 use Flutterwave\Library\Modal;
+use \Flutterwave\Config\ForkConfig;
 
-# start a session.
+// start a session.
 session_start();
 
+// Define custom config.
+// $myConfig = ForkConfig::setUp(
+//     'FLWSECK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X', //Secret key
+//     'FLWPUBK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X', // Public key
+//     'FLWSECK_TESTXXXXXXXXXXX', //Encryption key
+//     'staging' //Environment Variable
+// );
+
+// uncomment the block if you just want to pass the keys with a specific configuration.
+// $_ENV['SECRET_KEY'] = "FLWSECK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X";
+// $_ENV['PUBLIC_KEY'] = "FLWPUBK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X";
+// $_ENV['ENCRYPTION_KEY'] = "FLWSECK_TESTXXXXXXXXXXXX";
+// $_ENV['ENV'] = "staging";
+
+// controller default
+$controller = null;
+
 try {
-    Flutterwave::bootstrap();
+    Flutterwave::bootstrap(); // create a .env or Flutterwave::bootstrap($myConfig)
     $customHandler = new PaymentHandler();
     $client = new Flutterwave();
-    $modalType = Modal::POPUP; // Modal::POPUP or Modal::STANDARD
+    $modalType = Modal::STANDARD; // Modal::POPUP or Modal::STANDARD
     $controller = new PaymentController( $client, $customHandler, $modalType );
 } catch(\Exception $e ) {
     echo $e->getMessage();

setup.php

@@ -5,7 +5,7 @@
 
 $flutterwave_installation = 'composer';
 
-if( !file_exists( '.env' )) {
+if( !file_exists( '.env' ) && !is_dir('vendor')) {
     $dotenv = Dotenv::createImmutable(__DIR__."/../../../"); # on the event that the package is install via composer.
 } else {
     $flutterwave_installation = "manual";
@@ -17,7 +17,12 @@
 //check if the current version of php is compatible
 if(!Helper\CheckCompatibility::isCompatible())
 {
-    echo "Flutterwave: This SDK only support php version ". Helper\CheckCompatibility::MINIMUM_COMPATIBILITY. " or greater.";
+    if (PHP_SAPI === 'cli') {
+        echo "❌ Flutterwave: This SDK only support php version ". Helper\CheckCompatibility::MINIMUM_COMPATIBILITY. " or greater.";
+    } else {
+        echo "Flutterwave: This SDK only support php version ". Helper\CheckCompatibility::MINIMUM_COMPATIBILITY. " or greater.";
+    }
+
     exit;
 }
 
@@ -28,22 +33,27 @@
 try{
     foreach($flutterwaveKeys as $key)
     {
-        if( empty( $_ENV[ $key ] ) )
+        if(empty($_ENV[ $key ]) && empty(\getenv($key)))
         {
             throw new InvalidArgumentException("$key environment variable missing.");
         }
     }
 }catch(\Exception $e)
 {
-    echo "<code>Flutterwave sdk: " .$e->getMessage()."</code>";
+    if (PHP_SAPI === 'cli') {
+        echo "❌❌Flutterwave sdk: " .$e->getMessage();
+        echo "Kindly create a .env in the project root and add the required environment variables. ❌". PHP_EOL;
+    } else {
+        echo "<code>Flutterwave sdk: " .$e->getMessage()."</code>";
+        echo "<br /> Kindly create a <code>.env </code> in the project root and add the required environment variables.";
+    }
 
-    echo "<br /> Kindly create a <code>.env </code> in the project root and add the required environment variables.";
     exit;
 }
 
 $keys = [
-    'SECRET_KEY' => $_ENV['SECRET_KEY'],
-    'PUBLIC_KEY' => $_ENV['PUBLIC_KEY'],
-    'ENV' => $_ENV['ENV'],
-    'ENCRYPTION_KEY' => $_ENV['ENCRYPTION_KEY']
+    'SECRET_KEY' => $_ENV['SECRET_KEY'] ?? \getenv('SECRET_KEY'),
+    'PUBLIC_KEY' => $_ENV['PUBLIC_KEY'] ?? \getenv('PUBLIC_KEY'),
+    'ENV' => $_ENV['ENV'] ?? \getenv('ENV'),
+    'ENCRYPTION_KEY' => $_ENV['ENCRYPTION_KEY'] ?? \getenv('ENCRYPTION_KEY')
 ];

src/Config/AbstractConfig.php

@@ -43,7 +43,11 @@ protected function __construct(string $secret_key, string $public_key, string $e
             [
             'base_uri' => EnvVariables::BASE_URL,
             'timeout' => 60,
-            RequestOptions::VERIFY => \Composer\CaBundle\CaBundle::getSystemCaRootBundlePath()
+            'headers' => ['User-Agent' => sprintf(
+                'FlutterwavePHP/%d', EnvVariables::SDK_VERSION
+            )],
+            RequestOptions::VERIFY => 
+            \Composer\CaBundle\CaBundle::getSystemCaRootBundlePath()
             ]
         );
 

src/Contract/ControllerInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flutterwave\Contract;
+
+use Flutterwave\EventHandlers\EventHandlerInterface;
+use Flutterwave\Flutterwave;
+
+interface ControllerInterface {
+
+    public function __construct(
+        Flutterwave $client,
+        EventHandlerInterface $handler,
+        string $modalType
+    );
+
+}

src/EventHandlers/CardEventHandler.php

@@ -95,7 +95,8 @@ public function onAuthorization(\stdClass $response, ?array $resource = null): a
     {
         $logger = null;
         $data = [];
-        $mode = $response->meta->authorization->mode;
+
+        $mode = $resource['mode'] ?? $response->meta->authorization->mode;
 
         if (property_exists($response, 'data')) {
             $transactionId = $response->data->id;
@@ -124,6 +125,12 @@ public function onAuthorization(\stdClass $response, ?array $resource = null): a
             $data['instruction'] = $response->data->processor_response;
             $data['validate'] = true;
             break;
+        default:
+            $data['data_to_save']['status'] = $response->data->status; 
+            $data['data_to_save']['amount'] = $response->data->amount; 
+            $data['data_to_save']['currency'] = $response->data->currency; 
+            $data['data_to_save']['customer_name'] = $response->data->customer->name; 
+            $data['data_to_save']['customer_email'] = $response->data->customer->email; 
         }
 
         $data['mode'] = $mode;

src/Helper/EnvVariables.php

@@ -7,6 +7,7 @@
 class EnvVariables
 {
     public const VERSION = 'v3';
+    public const SDK_VERSION = '1.0.7';
     public const BASE_URL = 'https://api.flutterwave.com/' . self::VERSION;
     public const TIME_OUT = 30;
 }

src/HttpAdapter/CurlClient.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Flutterwave\Adapter;
+namespace Flutterwave\HttpAdapter;
 
 use Psr\Http\Message\ResponseFactoryInterface;
 

src/Service/CardPayment.php

@@ -131,14 +131,20 @@ public function encryption(string $params): string
      */
     public function handleAuthState(\stdClass $response, $payload): array
     {
-        $mode = $response->meta->authorization->mode;
+        // dd($response);
+        $data['request_data'] = null;
+
+        $mode = (\property_exists($response, 'meta') ) ? 
+        $response->meta->authorization->mode: $response->data->auth_model;
         if ($mode === 'pin') {
-            $data = $this->eventHandler->onAuthorization($response, ['logger' => $this->logger]);
             $data['request_data'] = $payload;
-            return $data;
         }
-
-        return $this->eventHandler->onAuthorization($response, ['logger' => $this->logger]);
+        $extra_data = $this->eventHandler->onAuthorization(
+            $response, 
+            ['logger' => $this->logger, 'mode' => $mode]
+        );
+
+        return array_merge([ 'request_data' => $data['request_data'] ], $extra_data);
     }
 
     public function getName(): string