Work in progress

Author: gregoriohc

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-All Notable changes to `:package_name` will be documented in this file
+All Notable changes to `twilio` will be documented in this file
 
 ## 1.0.0 - 201X-XX-XX
 

LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright (c) :author_name <:author_email>
+Copyright (c) Gregorio Hernández Caso <[email protected]>
 
 > Permission is hereby granted, free of charge, to any person obtaining a copy
 > of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,55 +1,76 @@
-Use this repo as a skeleton for your new channel, once you're done please submit a Pull Request on [this repo](https://github.com/laravel-notification-channels/new-channels) with all the files.
+# Twilio notifications channel for Laravel 5.3 [WIP]
 
-Here's the latest documentation on Laravel 5.3 Notifications System: 
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/twilio.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/twilio)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![Build Status](https://img.shields.io/travis/laravel-notification-channels/twilio/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/twilio)
+[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/twilio.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/twilio)
+[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/twilio.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/twilio)
 
-https://laravel.com/docs/master/notifications
-
-# A Boilerplate repo for contributions
-
-This package makes it easy to send notifications using [xxxxx](link to service) with Laravel 5.3.
-
-**Note:** Replace ```:channel_namespace``` ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line.
-This is where your description should go. Add a little code example so build can understand real quick how the package can be used. Try and limit it to a paragraph or two.
+This package makes it easy to send [Twilio notifications](https://documentation.twilio.com/docs) with Laravel 5.3.
 
+## Installation
 
+You can install the package via composer:
 
-## Contents
+``` bash
+composer require laravel-notification-channels/twilio
+```
 
-- [Installation](#installation)
-	- [Setting up the xxxx service](#setting-up-the-xxxx-service)
-- [Usage](#usage)
-	- [Available Message methods](#available-message-methods)
-- [Changelog](#changelog)
-- [Testing](#testing)
-- [Security](#security)
-- [Contributing](#contributing)
-- [Credits](#credits)
-- [License](#license)
+You must install the service provider:
 
+```php
+// config/app.php
+'providers' => [
+    ...
+    NotificationChannels\TwilioNotifications\Provider::class,
+];
+```
 
-## Installation
+## Usage
 
-Please also include the steps for any third-party service setup that's required for this package.
+Now you can use the channel in your `via()` method inside the notification:
 
-### Setting up the xxxx service
+``` php
+use NotificationChannels\TwilioNotifications\Channel;
+use NotificationChannels\TwilioNotifications\SmsMessage;
+use Illuminate\Notifications\Notification;
 
-Optionally include a few steps how users can set up the service.
+class AccountApproved extends Notification
+{
+    public function via($notifiable)
+    {
+        return [Channel::class];
+    }
 
-## Usage
+    public function toTwilio($notifiable)
+    {
+        return (new SmsMessage())
+            ->content("Your {$notifiable->service} account was approved!");
+    }
+}
+```
 
-Some code examples, make it clear how to use the package
+## Changelog
 
-### Available methods
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
 
-A list of all available options
+## Testing
+    
+``` bash
+$ composer test
+```
 
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
+## Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [Gregorio Hernández Caso](https://github.com/gregoriohc)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -5,30 +5,31 @@
     "license": "MIT",
     "authors": [
         {
-            "name": ":author_name",
-            "email": ":author_email",
-            "homepage": ":author_url",
+            "name": "Gregorio Hernández Caso",
+            "email": "[email protected]",
+            "homepage": "https://github.com/gregoriohc",
             "role": "Developer"
         }
     ],
     "require": {
         "php": ">=5.6.4",
+        "illuminate/events": "^5.3@dev",
         "illuminate/notifications": "^5.3@dev",
         "illuminate/support": "^5.3@dev",
-        "illuminate/events": "^5.3@dev"
+        "twilio/sdk": "^4.11"
     },
     "require-dev": {
         "mockery/mockery": "^0.9.5",
         "phpunit/phpunit": "4.*"
     },
     "autoload": {
         "psr-4": {
-            "NotificationChannels\\:channel_namespace\\": "src"
+            "NotificationChannels\\Twilio\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "NotificationChannels\\:channel_namespace\\Test\\": "tests"
+            "NotificationChannels\\Twilio\\Test\\": "tests"
         }
     },
     "config": {

phpunit.xml.dist

@@ -10,7 +10,7 @@
          processIsolation="false"
          stopOnFailure="false">
     <testsuites>
-        <testsuite name="Spatie Test Suite">
+        <testsuite name="Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>

src/CallMessage.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace NotificationChannels\Twilio;
+
+class CallMessage
+{
+    /**
+     * The message TwiML url.
+     *
+     * @var string
+     */
+    public $url;
+
+    /**
+     * The phone number the message should be sent from.
+     *
+     * @var string
+     */
+    public $from;
+
+    /**
+     * Create a new message instance.
+     *
+     * @param  string  $url
+     * @return void
+     */
+    public function __construct($url = '')
+    {
+        $this->url = $url;
+    }
+
+    /**
+     * Set the message content.
+     *
+     * @param  string  $url
+     * @return $this
+     */
+    public function url($url)
+    {
+        $this->url = $url;
+
+        return $this;
+    }
+
+    /**
+     * Set the phone number the message should be sent from.
+     *
+     * @param  string  $from
+     * @return $this
+     */
+    public function from($from)
+    {
+        $this->from = $from;
+
+        return $this;
+    }
+}

src/Channel.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace NotificationChannels\Twilio;
+
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Twilio\Events\MessageWasSent;
+use NotificationChannels\Twilio\Events\SendingMessage;
+use NotificationChannels\Twilio\Exceptions\CouldNotSendNotification;
+use Services_Twilio;
+
+class Channel
+{
+    /**
+     * @var \Services_Twilio
+     */
+    protected $twilio;
+
+    public function __construct(Services_Twilio $twilio)
+    {
+        $this->twilio = $twilio;
+    }
+
+    /**
+     * Send the given notification.
+     *
+     * @param  mixed $notifiable
+     * @param  \Illuminate\Notifications\Notification $notification
+     * @return void
+     * @throws CouldNotSendNotification
+     */
+    public function send($notifiable, Notification $notification)
+    {
+        if (!$to = $notifiable->routeNotificationFor('twilio')) {
+            return;
+        }
+
+        $config = config('services.twilio');
+
+        $message = $notification->toTwilio($notifiable);
+
+        if (is_string($message)) {
+            $message = new SmsMessage($message);
+        }
+
+        if (!$message instanceof SmsMessage::class &&
+            !$message instanceof CallMessage::class
+        ) {
+            $class = get_class($message) ?: 'Unknown';
+
+            throw CouldNotSendNotification::invalidMessageObject($class);
+        }
+
+        $shouldSendMessage = event(new SendingMessage($notifiable, $notification, $message), [], true) !== false;
+
+        if (!$shouldSendMessage) {
+            return;
+        }
+
+        $response = null;
+
+        /** @var SmsMessage|CallMessage $message */
+        try {
+            if ($message instanceof SmsMessage::class) {
+                $response = $this->twilio->account->messages->sendMessage(
+                    $message->from ?: $config['from'],
+                    $to,
+                    trim($message->content)
+                );
+            } elseif ($message instanceof CallMessage::class) {
+                $response = $this->twilio->account->calls->create(
+                    $message->from ?: $config['from'],
+                    $to,
+                    trim($message->url)
+                );
+            }
+        } catch (\Exception $exception) {
+            throw CouldNotSendNotification::serviceRespondedWithAnException($exception);
+        }
+
+        event(new MessageWasSent($notifiable, $notification, $response));
+    }
+}

src/Events/MessageWasSent.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace NotificationChannels\:channel_namespace\Events;
+namespace NotificationChannels\Twilio\Events;
 
 use Illuminate\Notifications\Notification;
 
@@ -11,14 +11,17 @@ class MessageWasSent
     /** @var \Illuminate\Notifications\Notification */
     protected $notification;
 
+    protected $response;
+
     /**
      * @param $notifiable
      * @param \Illuminate\Notifications\Notification $notification
+     * @param mixed|null $response
      */
-    public function __construct($notifiable, Notification $notification)
+    public function __construct($notifiable, Notification $notification, $response = null)
     {
         $this->notifiable = $notifiable;
-
         $this->notification = $notification;
+        $this->response = $response;
     }
 }

src/Events/SendingMessage.php

@@ -1,25 +1,27 @@
 <?php
 
-namespace NotificationChannels\:channel_namespace\Events;
+namespace NotificationChannels\Twilio\Events;
 
 use Illuminate\Notifications\Notification;
 
 class SendingMessage
 {
-
     protected $notifiable;
 
     /** @var \Illuminate\Notifications\Notification */
     protected $notification;
 
+    protected $message;
+
     /**
      * @param $notifiable
      * @param \Illuminate\Notifications\Notification $notification
+     * @param \NotificationChannels\Twilio\SmsMessage|\NotificationChannels\Twilio\CallMessage|mixed $message
      */
-    public function __construct($notifiable, Notification $notification)
+    public function __construct($notifiable, Notification $notification, $message)
     {
         $this->notifiable = $notifiable;
-
         $this->notification = $notification;
+        $this->message = $message;
     }
 }