kineticamobile / lubichannel

0.1 2020-10-16 15:27 UTC

Requires

• php: >=7.2.5
• guzzlehttp/guzzle: ^6.0
• illuminate/notifications: ~7.0 || ~8.0
• illuminate/support: ~7.0 || ~8.0

Requires (Dev)

• mockery/mockery: ^1.0
• orchestra/testbench: ^5.3
• phpunit/phpunit: ^8.0

MIT

• Daniel Macías Ramos

• kineticamobile
• lubichannel

Published on Packagist.org on 2020-10-16 16:57 UTC

README

This package makes it easy to send notifications using Ubicual with Laravel 7.x and 8.x

Contents

• Installation
  • Setting up the Ubicual service
• Usage
  • On-Demand Notifications
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require kineticamobile/lubichannel

Setting up your Ubicual account

Add your Ubicual Product Token and default originator (name or number of sender) to your config/ubicual.php:

// config/ubicual.php
...
return [
    'api_token' => env('UBICUAL_API_TOKEN'),
    'from' => env('UBICUAL_FROM', 'Ubicual'),
    'base_url' => env('UBICUAL_BASE_URL', 'https://api.ubicual.com/api/v1/sms/send'),
];

...

Usage

You can use the channel in your via() method inside the notification:

use Illuminate\Notifications\Notification;
use Kineticamobile\Ubicual\UbicualMessage;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return ["ubicual"];
    }

    public function toUbicual($notifiable)
    {
        return (new UbicualMessage)->content("Your account was approved!");
    }
}

In your notifiable model, make sure to include a routeNotificationForUbicual() method, which returns a phone number or an array of phone numbers.

public function routeNotificationForUbicual()
{
    return $this->phone_number;
}

On-Demand Notifications

Sometimes you may need to send a notification to someone who is not stored as a "user" of your application. Using the Notification::route method, you may specify ad-hoc notification routing information before sending the notification:

Notification::route('ubicual', '5555555555')
            ->notify(new InvoicePaid($invoice));

Available Message methods

from(''): Accepts a phone number/sender name to use as the notification sender.. Make sure to register the sender name at you Ubicual dashboard.

content(''): Accepts a string value for the notification body.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

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

Contributing

Please see CONTRIBUTING for details.

Credits

• Daniel Macías
• Raul Tierno
• Emilio Ortiz

License

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