v1.0.1 2017-05-18 07:23 UTC

README

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

This package makes it easy to send notifications using JetSMS with Laravel 5.3.

Contents

Installation

You can install this package via composer:

composer require laravel-notification-channels/jet-sms

Next add the service provider to your config/app.php:

...
'providers' => [
    ...
    NotificationChannels\JetSMS\JetSMSServiceProvider::class,
],
...

Setting up the JetSMS service

You will need to register to JetSMS to use this channel.

The configuration given by the JetSMS should be included within your config/services.php file:

...
'JetSMS' => [
    'http'       => [
        'endpoint' => '',
    ],
    'username'   => '',
    'password'   => '',
    'originator' => '', // Sender name.
    'timeout'    => 60,
],
...

Usage

Follow Laravel's documentation to add the channel to your Notification class.

use NotificationChannels\JetSMS\JetSMSChannel;
use NotificationChannels\JetSMS\JetSMSMessage;

class ResetPasswordWasRequested extends Notification
{
    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [JetSMSChannel::class];
    }
    
    /**
     * Get the JetSMS representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return string|\NotificationChannels\JetSMS\JetSMSMessage
     */
    public function toJetSMS($notifiable) {
        return "Test notification";
        // Or
        return new JetSMSMessage("Test notification", $notifiable->phone_number);
    }
}

Don't forget to place the dedicated method for JetSMS inside your notifiables. (e.g. User)

class User extends Authenticatable
{
    use Notifiable;
    
    public function routeNotificationForJetSMS()
    {
        return "905123456789";
    }
}

Available methods

Check out the constructor signature of JetSMSMessage:

public function __construct($content, $number, $originator = null, $sendDate = null);

If you both place the originator (Outbox name) to your configuration and your JetSMSMessage instance, the outbox name set by the JetSMSMessage instance will be valid.

Available events

JetSMS Notification channel comes with two handy events which provides the required information about the SMS messages.

  1. Message Was Sent (NotificationChannels\JetSMS\Events\MessageWasSent)

This event is fired shortly after the message is sent. An example handler is presented below:

namespace App\Listeners;

use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use NotificationChannels\JetSMS\Events\MessageWasSent;

class SentMessageHandler
{
    /**
     * Handle the event.
     *
     * @param  MessageWasSent  $event
     * @return void
     */
    public function handle(MessageWasSent $event)
    {
        $response = $event->response;
        $message = $event->message;

        // The message properties.
        \Log::info($message->content());
        \Log::info($message->number());
        \Log::info($message->originator());
        \Log::info($message->sendDate());

        // Message as array.
        \Log::info($message->toArray());

        // API Response properties.
        \Log::info($response->isSuccess());
        \Log::info($response->errorCode());
        \Log::info($response->errorMessage());
        \Log::info($response->messageReportIdentifiers());
    }
}
  1. Sending Message (NotificationChannels\JetSMS\Events)

This event is fired just before the send request. An example handler is presented below.

namespace App\Listeners;

use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use NotificationChannels\JetSMS\Events\SendingMessage;

class SendingMessageHandler
{
    /**
     * Handle the event.
     *
     * @param  SendingMessage  $event
     * @return void
     */
    public function handle(SendingMessage $event)
    {
        $message = $event->message;

        // The message properties.
        \Log::info($message->content());
        \Log::info($message->number());
        \Log::info($message->originator());
        \Log::info($message->sendDate());

        // Message as array.
        \Log::info($message->toArray());
    }
}

Notes

The JetSMS message is immutable. Once constructed, no way to mutate.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email erdemkeren@gmail.com instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

License

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