Merge pull request #6 from OgunsakinDamilola/feat/tests-and-upgrades

wip: PHP 8, Laravel 8&9 support, test environment setup

.phpunit.result.cache

@@ -0,0 +1 @@
+{"version":1,"defects":{"OgunsakinDamilola\\Interswitch\\Tests\\Unit\\InterswitchPaymentModelTest::model_can_be_initiated_with_factory":4},"times":{"OgunsakinDamilola\\Interswitch\\Tests\\Unit\\InterswitchPaymentModelTest::model_can_be_initiated_with_factory":0.25}}

composer.json

@@ -8,10 +8,21 @@
             "email": "ogunsakin191@gmail.com"
         }
     ],
+    "require": {
+        "php": "^7.4|^8.0",
+        "illuminate/support": "^8.0",
+        "doctrine/dbal": "^2.10",
+        "laravel/legacy-factories": "^1.1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.0",
+        "orchestra/testbench": "^6.21"
+    },
     "minimum-stability": "stable",
     "autoload": {
         "psr-4": {
-            "OgunsakinDamilola\\Interswitch\\": "src/"
+            "OgunsakinDamilola\\Interswitch\\": "src/",
+            "OgunsakinDamilola\\Interswitch\\Tests\\": "tests/"
         }
     },
     "extra": {

phpunit.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         testdox="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="DB_CONNECTION" value="testing" force="true"/>
+        <env name="DB_DATABASE" value=":memory:" force="true"/>
+        <env name="APP_ENV" value="testing" force="true"/>
+    </php>
+</phpunit>

src/Interswitch.php

@@ -1,14 +1,12 @@
 <?php
-
-
 namespace OgunsakinDamilola\Interswitch;
 
 use Illuminate\Support\Arr;
 use OgunsakinDamilola\Interswitch\Models\InterswitchPayment;
 
 class Interswitch extends InterswitchTransactionsHelper
 {
-    public function generatePayment($paymentData): array
+    public function generatePayment($paymentData)
     {
         $amount = $paymentData['amount'] * 100;
         $reference = $this->transactionReferenceHandler(Arr::get($paymentData, 'reference', ''));
@@ -27,7 +25,7 @@ public function generatePayment($paymentData): array
             'response_full' => ''
         ];
         InterswitchMailHandler::newPaymentNotification($paymentData['customer_email'], $payment);
-        InterswitchPayment::create($payment);
+        InterswitchPayment::query()->create($payment);
         return [
             'customerId' => $paymentData['customer_id'],
             'customerName' => $paymentData['customer_name'],

src/InterswitchMailHandler.php

@@ -1,6 +1,4 @@
 <?php
-
-
 namespace OgunsakinDamilola\Interswitch;
 
 
@@ -11,16 +9,16 @@
 
 class InterswitchMailHandler
 {
-    public static function newPaymentNotification(string $email, array $paymentData): void
+    public static function newPaymentNotification($email, $paymentData)
     {
         try {
             Mail::to($email)->send(new PrePaymentNotification($paymentData));
         } catch (\Exception $e) {
-            // dd($e->getMessage());
+            abort(500, $e->getMessage());
         }
     }
 
-    public static function paymentNotification(string $email, array $paymentData): void
+    public static function paymentNotification($email, $paymentData)
     {
         try {
             if (! in_array($paymentData['response_code'], ['00', '01', '11', '10'])) {
@@ -29,7 +27,7 @@ public static function paymentNotification(string $email, array $paymentData): v
                 Mail::to($email)->send(new PaymentSuccessful($paymentData));
             }
         } catch (\Exception $e){
-            // dd($e->getMessage());
+            abort(500, $e->getMessage());
         }
     }
 

src/InterswitchTransactionsHelper.php

@@ -1,5 +1,5 @@
 <?php
-namespace OgunsakinDamilola\interswitch;
+namespace OgunsakinDamilola\Interswitch;
 
 class interswitchTransactionsHelper
 {

src/Models/InterswitchPayment.php

@@ -6,7 +6,7 @@
 
 class InterswitchPayment extends Model
 {
-    protected $fillable = [ 'id', 'customer_id',
+    protected $fillable = ['id', 'customer_id',
         'customer_name', 'customer_email',
         'environment', 'gateway', 'reference',
         'amount', 'response_code', 'response_description'];

src/database/database.sqlite

@@ -0,0 +1,34 @@
+PRAGMA journal_mode = MEMORY;
+PRAGMA synchronous = OFF;
+PRAGMA foreign_keys = OFF;
+PRAGMA ignore_check_constraints = OFF;
+PRAGMA auto_vacuum = NONE;
+PRAGMA secure_delete = OFF;
+BEGIN TRANSACTION;
+
+DROP TABLE IF EXISTS `interswitch_payment`;
+
+CREATE TABLE `interswitch_payments` (
+`id` INTEGER  NOT NULL ,
+`created_at` timestamp NULL DEFAULT NULL,
+`updated_at` timestamp NULL DEFAULT NULL,
+`customer_id` INTEGER  NOT NULL,
+`customer_name` TEXT  NOT NULL,
+`customer_email` TEXT  NOT NULL,
+`environment` TEXT  NOT NULL,
+`gateway` TEXT  NOT NULL,
+`reference` TEXT  NOT NULL,
+`amount` TEXT  NOT NULL,
+`response_code` TEXT  NOT NULL,
+`response_description` TEXT  NULL DEFAULT NULL,
+`response_full` TEXT  NULL DEFAULT NULL,
+`payment_status` TEXT  NULL DEFAULT NULL,
+PRIMARY KEY (`id`)
+);
+
+
+COMMIT;
+PRAGMA ignore_check_constraints = ON;
+PRAGMA foreign_keys = ON;
+PRAGMA journal_mode = WAL;
+PRAGMA synchronous = NORMAL;

src/database/factories/InterswitchPaymentFactory.php

@@ -0,0 +1,20 @@
+<?php
+
+use Faker\Generator as Faker;
+use OgunsakinDamilola\Interswitch\Models\InterswitchPayment;
+
+
+$factory->define(InterswitchPayment::class, function (Faker $faker) {
+    return [
+        'customer_id' => $faker->randomNumber(1),
+        'customer_name' => $faker->name,
+        'customer_email' => $faker->email,
+        'environment' => 'TEST',
+        'gateway' => 'WEBPAY',
+        'reference' => uniqid(),
+        'amount' => 20000,
+        'response_code' => '00',
+        'response_description' => 'Success'
+    ];
+});
+

src/databases/migrations/2020_02_27_024014_create_interswitch_payments_table.php → src/database/migrations/2020_02_27_024014_create_interswitch_payments_table.php

@@ -24,6 +24,8 @@ public function up()
             $table->bigInteger('amount'); // always store in kobo
             $table->string('response_code')->nullable();
             $table->string('response_description')->nullable();
+            $table->longText('response_full')->nullable();
+            $table->integer('payment_status')->nullable();
             $table->timestamps();
         });
     }

src/database/setup_default_tables_2022.php

@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+
+class SetupDefaultTables2022 extends Migration
+{
+
+    public function up()
+    {
+        if (!Schema::hasTable('interswitch_payments')) {
+            DB::unprepared(file_get_contents(__DIR__.DIRECTORY_SEPARATOR.'database.sqlite'));
+        }
+    }
+
+    public function down()
+    {
+        //
+    }
+}

tests/TestCase.php

@@ -0,0 +1,35 @@
+<?php
+namespace OgunsakinDamilola\Interswitch\Tests;
+
+use Illuminate\Database\Eloquent\Factory as EloquentFactory;
+use OgunsakinDamilola\Interswitch\InterswitchServiceProvider;
+use Orchestra\Testbench\TestCase as BaseTestCase;
+
+class TestCase extends BaseTestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->app->make(EloquentFactory::class)->load($this->baseDir().DIRECTORY_SEPARATOR.'database'.DIRECTORY_SEPARATOR.'factories');
+
+    }
+
+    protected function getPackageProviders($app)
+    {
+        return [
+            InterswitchServiceProvider::class,
+        ];
+    }
+
+    protected function getEnvironmentSetUp($app)
+    {
+        include_once $this->baseDir().DIRECTORY_SEPARATOR.'database'.DIRECTORY_SEPARATOR.'setup_default_tables_2022.php';
+
+        (new \SetupDefaultTables2022)->up();
+    }
+
+    private function baseDir(){
+        return str_replace('tests','src',__DIR__);
+    }
+}

tests/Unit/InterswitchPaymentModelTest.php

@@ -0,0 +1,24 @@
+<?php
+namespace OgunsakinDamilola\Interswitch\Tests\Unit;
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use OgunsakinDamilola\Interswitch\Models\InterswitchPayment;
+use OgunsakinDamilola\Interswitch\Tests\TestCase;
+
+class InterswitchPaymentModelTest extends TestCase
+{
+    use RefreshDatabase;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+    }
+
+    /** @test */
+    public function model_can_be_initiated_with_factory()
+    {
+        $model = factory(InterswitchPayment::class)->create();
+
+        $this->assertTrue($model instanceof InterswitchPayment);
+    }
+}