unicodeveloper/laravel-jusibe

A Jusibe Bridge for Laravel 5

1.0.1 2019-11-12 13:35 UTC

Requires

• php: ^7.0|^7.1|^7.2

Requires (Dev)

• phpunit/phpunit: 4.*
• scrutinizer/ocular: ~1.1

MIT

• Prosper Otemuyiwa

• package
• php
• api
• sms
• Bridge
• laravel
• unicodeveloper
• jusibe
• laravel-jusibe

README

Laravel 5 Wrapper for Jusibe

Installation

Before you go ahead to install the package, make sure you have Jusibe PHP library installed.

PHP 7.0+ or HHVM 3.3+, and Composer are required First, pull in the package through Composer.

$ composer require unicodeveloper/laravel-jusibe

Another alternative is to simply add the following line to the require block of your composer.json file.

"unicodeveloper/laravel-jusibe": "1.0.*"

Then run composer install or composer update to download it and have the autoloader updated.

Once Laravel Jusibe is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

• Unicodeveloper\JusibePack\JusibeServiceProvider::class

Also, register the Facade like so:

'aliases' => [
    ...
    'Jusibe' => Unicodeveloper\JusibePack\Facades\Jusibe::class,
    ...
]

Configuration

You can publish the configuration file using this command:

php artisan vendor:publish --provider="Unicodeveloper\JusibePack\JusibeServiceProvider"

A configuration-file named jusibe.php with some sensible defaults will be placed in your config directory:

<?php

return [
    /**
     * Public Key From Jusibe Dashboard
     *
     */
    'publicKey' => getenv('JUSIBE_PUBLIC_KEY'),
    /**
     * Access Token From Jusibe  Dashboard
     *
     */
    'accessToken' => getenv('JUSIBE_ACCESS_TOKEN'),
];

Get the publicKey and accessToken from Jusibe API Keys Section

Usage

Available methods for use are:

/**
 * Send SMS using the Jusibe API
 * @param  array $payload
 * @return object
 */
Jusibe::sendSMS($payload)->getResponse();

/**
 * Check the available SMS credits left in your Jusibe account
 * @return object
 */
Jusibe::checkAvailableCredits()->getResponse();

/**
 * Check the delivery status of a sent SMS
 * @param  string $messageID
 * @return object
 */
Jusibe::checkDeliveryStatus('8nb1wrgdjw')->getResponse();

Send an SMS

<?php

$message = "I LOVE YOU, BABY";

$payload = [
    'to' => '7079740987',
    'from' => 'PROSPER DATING NETWORK',
    'message' => $message
];

try {
    $response = Jusibe::sendSMS($payload)->getResponse();
    print_r($response);
} catch(Exception $e) {
    echo $e->getMessage();
}

Check SMS Credits

<?php

try {
   $response = Jusibe::checkAvailableCredits()->getResponse();
   print_r($response);
} catch(Exception $e) {
   echo $e->getMessage();
}

Check Delivery Status

<?php

try {
    $response = Jusibe::checkDeliveryStatus('8nb1wrgdjw')->getResponse();
    print_r($response);
} catch(Exception $e) {
    echo $e->getMessage();
}

Send a Bulk SMS

<?php

// include your composer dependencies
require_once 'vendor/autoload.php';

use Unicodeveloper\Jusibe\Jusibe;

$publicKey = 'xxxxxxxxxxxxxx';
$accessToken = 'xxxxxxxxxxxxxx';

$jusibe = new Jusibe($publicKey, $accessToken);

$message = "You are invited for party!!!";

$payload = [
    'to' => '7079740987,8077139164',
    'from' => 'DOZIE GROUP',
    'message' => $message
];

try {
    $response = $jusibe->sendBulkSMS($payload)->getResponse();
    print_r($response);
} catch(Exception $e) {
    echo $e->getMessage();
}

Response Info for Developer

Check Bulk Delivery Status

<?php

// include your composer dependencies
require_once 'vendor/autoload.php';

use Unicodeveloper\Jusibe\Jusibe;

$publicKey = 'xxxxxxxxxxxxxx';
$accessToken = 'xxxxxxxxxxxxxx';

$jusibe = new Jusibe($publicKey, $accessToken);

try {
    $response = $jusibe->checkBulkDeliveryStatus('n2v9gby1jy')->getResponse();
    print_r($response);
} catch(Exception $e) {
    echo $e->getMessage();
}

Response Info for Developer

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

You can run the tests with:

vendor/bin/phpunit run

Alternatively, you can run the tests like so:

composer test

Contributing

Please see CONTRIBUTING for details.

Credits

• Prosper Otemuyiwa

License

The MIT License (MIT). Please see License File for more information.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.