Rave Widget

A light-weight library to manage rave payment requests and response for Laravel apps and PHP projects in General

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

PHP >= 7.1
PHP PDO Extension

For Laravel:

Laravel >= 5.5.0

Installing

composer require remade/rave-widget

Afterwards, on Laravel, run php artisan vendor:publish --provider=Remade\RaveWidget\Laravel\ServiceProvider

Usage

Define your Configuration values:

$configuration_values = [
    'database' => [
        'database_type' => 'mysql',
        'database_name' => 'my_db_name',
        'server' => 'my_db_host_address',
        'username' => 'my_db_username',
        'password' => 'my_db_password',
    ],

    'widget' => [
        'payment_request_table_name' => 'payment_request_table', //default
    ],

    'rave' => [
        'public_key' => '*******************************************', //get from rave
        'secret_key' => '*******************************************', //get from rave
        'environment' => 'test|live',
    ]
];

For Laravel apps, the configuration is already published to the app's config path in a rave.widget.php file. Edit as necessary.

Instantiating the Widget Object can be done in one of two ways. There is no drawback irrespective of which way you choose.

You can create a new instance of the Configuration class and use it to instantiate the Widget:

$config = new \Remade\RaveWidget\Core\Configuration($configuration_values);
$widget = new \Remade\RaveWidget\Widget($config);

or you can just initialize straight away with the configuration values:

$widget = new \Remade\RaveWidget\Widget($configuration_values);

For Laravel, all these has already been taken care of. After you must have updated rave.widget.php file in Laravel's app config path, the widget instance will be available as

$widget = RaveWidget::instance();

Setting up Payments

The payment details are set on the payment object. This object is available via $widget->payment()

$wigdet->payment()->setEmail('[email protected]')->setAmount(100)->setCurrency('NGN');

Available Methods are:

setAmount(decimal)
setPaymentMethod(string)
setDescription(string)
setLogo(url)
setTitle(string)
setCountry(string)
setCurrency(string)
setEmail(email)
setFirstname(string)
setLastname(string)
setPhoneNumber(string)
setPayButtonText(string)
setRedirectUrl(url)
setMetaData(array)

All set property method have an equivalent get method e.g. setAmount(amount) and getAmount()

Setting Configuration

You can update configuration values at run time. The Configuration instance is available on Widget instance i.e $widget->configuration()

Making Payment Request

$widget = \RaveWidget::instance();
$widget->payment()->setEmail('[email protected]')->setAmount(100)->setCurrency('NGN');
$widget->makePaymentRequest($render)

Where $render is a string with default value self_hosted. Acceptable values are self_hosted, rave_hosted and data

Verifying Payment

$transaction = $widget->verifyTransaction($transactionReference) This would be called typically on callback/webhook response.

Running the tests

phpunit

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details