remade/rave-widget

A light-weight payment request library for Rave; for Laravel apps and composer aware PHP apps in general

Rave Widget

A light-weight library to manage rave payment requests and response for Laravel apps and PHP projects in General, _(*1)

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., _(*2)

Prerequisites

PHP >= 7.1
PHP PDO Extension

For Laravel:, _(*3)

Laravel >= 5.5.0

Installing

composer require remade/rave-widget

Afterwards, on Laravel, run php artisan vendor:publish --provider=Remade\RaveWidget\Laravel\ServiceProvider, _(*4)

Usage

Define your Configuration values:, _(*5)

$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., _(*6)

Instantiating the Widget Object can be done in one of two ways. There is no drawback irrespective of which way you choose., _(*7)

You can create a new instance of the Configuration class and use it to instantiate the Widget:, _(*8)

$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:, _(*9)

$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, _(*10)

$widget = RaveWidget::instance();

Setting up Payments

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

$wigdet->payment()->setEmail('mail4remi@yahoo.com')->setAmount(100)->setCurrency('NGN');

Available Methods are:, _(*12)

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(), _(*13)

Setting Configuration

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

Making Payment Request

$widget = \RaveWidget::instance();
$widget->payment()->setEmail('mail4remi@gmail.com')->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, _(*15)

Verifying Payment

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

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., _(*17)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*18)

License

This project is licensed under the MIT License - see the LICENSE.md file for details, _(*19)