General Update: Enhanced Features and Improved Performance

.docker/.gitpod.Dockerfile

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

.env.example

@@ -1,4 +1,5 @@
-PUBLIC_KEY=FLWPUBK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
-SECRET_KEY=FLWSECK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
-ENCRYPTION_KEY=FLWSECK_XXXXXXXXXXXXXXXX
-ENV=staging
+FLW_PUBLIC_KEY=FLWPUBK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
+FLW_SECRET_KEY=FLWSECK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
+FLW_ENCRYPTION_KEY=FLWSECK_XXXXXXXXXXXXXXXX
+FLW_ENV=staging
+FLW_LOG_DIR=logs

.github/workflows/artifact-release.yml

@@ -0,0 +1,44 @@
+name: Build and Upload PHP Artifacts
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'  # Match tags like 1.2.3
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php: ['7.4', '8.1', '8.2', '8.3', '8.4']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite
+
+      - name: Install dependencies
+        run: composer install --no-dev --optimize-autoloader
+
+      - name: Get tag version
+        id: tag
+        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> "$GITHUB_ENV"
+
+      - name: Create release artifact
+        run: |
+          mkdir -p build
+          cp -r vendor src tests assets composer.json composer.lock .gitignore LICENSE phpunit.xml.dist .env.example processPayment.php paymentForm.php setup.php README.md CHANGELOG.md build/
+          cd build && zip -r ../flutterwave-php-${VERSION}-php${{ matrix.php }}.zip . && cd ..
+
+      - name: Upload artifact to release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: flutterwave-php-${{ env.VERSION }}-php${{ matrix.php }}.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.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

.gitignore

@@ -198,4 +198,6 @@ example.php
 .phpunit.cache
 coverage.xml
 .env.local
-.php-cs-fixer.cache
+.php-cs-fixer.cache
+.idx/
+.vscode/

.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
+
+

README.md

@@ -47,6 +47,9 @@ Available features include:
 
 ## Installation
 
+### Download Release Artifact
+If you do not want to make use of composer. each [release](https://github.com/Flutterwave/PHP-v3/releases/) contains a zip with all the dependencies installed. Simply download the one that supports your php version.
+
 ### Installation via Composer.
 
 To install the package via Composer, run the following command.
@@ -67,10 +70,11 @@ cp .env.example .env
 Your `.env` file should look this.
 
 ```env
-PUBLIC_KEY=FLWSECK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
-SECRET_KEY=FLWPUBK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
-ENCRYPTION_KEY=FLWSECK_XXXXXXXXXXXXXXXX
-ENV='staging/production'
+FLW_PUBLIC_KEY=FLWSECK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
+FLW_SECRET_KEY=FLWPUBK_TEST-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-X
+FLW_ENCRYPTION_KEY=FLWSECK_XXXXXXXXXXXXXXXX
+FLW_ENV='staging/production'
+FLW_LOG_DIR=logs
 ```
 
 ### Render Payment Modal

composer.json

@@ -21,6 +21,7 @@
         "ext-openssl": "*",
         "guzzlehttp/guzzle": "^7.5",
         "psr/http-client": "^1.0",
+        "psr/log": "^1.1 || ^2.0 || ^3.0",
         "php-http/guzzle7-adapter": "^1.0",
         "composer/ca-bundle": "^1.3"
     },

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,29 @@
 try{
     foreach($flutterwaveKeys as $key)
     {
-        if( empty( $_ENV[ $key ] ) )
+
+        $new_key = sprintf( 'FLW_%s', $key );
+        if(empty($_ENV[ $new_key ]) && empty(\getenv($new_key)) && empty($_ENV[ $key ]) && empty(\getenv($key)))
         {
-            throw new InvalidArgumentException("$key environment variable missing.");
+            throw new InvalidArgumentException("$new_key or $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 "Flutterwave: Setup incomplete. check your environment variables are set currently. confirm .env contains the required 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['FLW_SECRET_KEY'] ?? ($_ENV['SECRET_KEY'] ?? getenv('FLW_SECRET_KEY') ?: getenv('SECRET_KEY')),
+    'PUBLIC_KEY' => $_ENV['FLW_PUBLIC_KEY'] ?? ($_ENV['PUBLIC_KEY'] ?? getenv('FLW_PUBLIC_KEY') ?: getenv('PUBLIC_KEY')),
+    'ENV' => $_ENV['FLW_ENV'] ?? ($_ENV['ENV'] ?? getenv('FLW_ENV') ?: getenv('ENV')),
+    'ENCRYPTION_KEY' => $_ENV['FLW_ENCRYPTION_KEY'] ?? ($_ENV['ENCRYPTION_KEY'] ?? getenv('FLW_ENCRYPTION_KEY') ?: getenv('ENCRYPTION_KEY'))
 ];

src/Config/AbstractConfig.php

@@ -23,7 +23,7 @@ abstract class AbstractConfig
     public const ENV = 'ENV';
     public const DEFAULT_PREFIX = 'FW|PHP';
     public const LOG_FILE_NAME = 'flutterwave-php.log';
-    protected Logger $logger;
+    public Logger $logger;
     protected string $secret;
     protected string $public;
 
@@ -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/Config/PackageConfig.php

@@ -25,11 +25,31 @@ private function __construct(string $secretKey, string $publicKey, string $encry
         $this->logger->pushHandler(new RotatingFileHandler(__DIR__ . "../../../../../../" . self::LOG_FILE_NAME, 90));
     }
 
-    public static function setUp(string $secretKey, string $publicKey, string $enc, string $env): ConfigInterface
+    public static function setUp(string $secretKey, string $publicKey, string $enc, string $env, ?LoggerInterface $customLogger = null): ConfigInterface
     {
-
         if (is_null(self::$instance)) {
-            return new self($secretKey, $publicKey, $enc, $env);
+            $instance = new self($secretKey, $publicKey, $enc, $env);
+            if ($customLogger) {
+                $instance->logger = $customLogger;
+            } else {
+                $rootPath = __DIR__ . '/../../../../../../';
+                $logDir = $rootPath . $_ENV['FLW_LOG_DIR'] ?? 'logs';
+
+                if (!is_dir($logDir)) {
+                    if (!mkdir($logDir, 0775, true) && !is_dir($logDir)) {
+                        throw new \RuntimeException("Flutterwave: Failed to create log directory at $logDir");
+                    }
+                }
+
+                if (!is_writable($logDir)) {
+                    throw new \RuntimeException("Flutterwave: Log directory is not writable: $logDir");
+                }
+
+                $instance->logger->pushHandler(
+                    new RotatingFileHandler($logDir . '/' . self::LOG_FILE_NAME, 90)
+                );
+            }
+            self::$instance = $instance;
         }
         return self::$instance;
     }