From 71b6d07bea3adfe3c7799b397e3bc76448e3def8 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Thu, 31 Dec 2020 18:58:33 +0100 Subject: [PATCH 01/10] first commit --- .editorconfig | 15 +++ .gitignore | 6 + .styleci.yml | 1 + CHANGELOG.md | 7 ++ CONTRIBUTING.md | 55 +++++++++ LICENSE.md | 21 ++++ README.md | 119 ++++++++++++++++++++ composer.json | 49 ++++++++ phpunit.xml.dist | 22 ++++ src/Exceptions/CouldNotSendNotification.php | 11 ++ src/Exceptions/InvalidConfiguration.php | 13 +++ src/UnifonicChannel.php | 52 +++++++++ src/UnifonicClient.php | 75 ++++++++++++ src/UnifonicMessage.php | 59 ++++++++++ src/UnifonicServiceProvider.php | 29 +++++ tests/UnifonicChannelTest.php | 72 ++++++++++++ tests/UnifonicClientTest.php | 64 +++++++++++ tests/UnifonicMessageTest.php | 27 +++++ 18 files changed, 697 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 .styleci.yml create mode 100755 CHANGELOG.md create mode 100755 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 composer.json create mode 100644 phpunit.xml.dist create mode 100644 src/Exceptions/CouldNotSendNotification.php create mode 100644 src/Exceptions/InvalidConfiguration.php create mode 100644 src/UnifonicChannel.php create mode 100644 src/UnifonicClient.php create mode 100644 src/UnifonicMessage.php create mode 100644 src/UnifonicServiceProvider.php create mode 100644 tests/UnifonicChannelTest.php create mode 100644 tests/UnifonicClientTest.php create mode 100644 tests/UnifonicMessageTest.php diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..cd8eb86e --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..4e62afc2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ + +/vendor +build +composer.phar +composer.lock +.phpunit.result.cache \ No newline at end of file diff --git a/.styleci.yml b/.styleci.yml new file mode 100644 index 00000000..0285f179 --- /dev/null +++ b/.styleci.yml @@ -0,0 +1 @@ +preset: laravel diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100755 index 00000000..fb1b006a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `unifonic` will be documented in this file + +## 1.0.0 - 201X-XX-XX + +- initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100755 index 00000000..4da74e3f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the +world that developers are civilized and selfless people. + +It's the duty of the maintainer to ensure that all submissions to the project are of sufficient +quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open +source projects are used by many developers, who may have entirely different needs to your own. Think about +whether or not your feature is likely to be used by other users of the project. + +## Procedure + +Before filing an issue: + +- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +Before submitting a pull request: + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Requirements + +If the project maintainer has any additional requirements, you will find them listed here. + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +**Happy coding**! diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..9d86a80e --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright (c) imad + +> Permission is hereby granted, free of charge, to any person obtaining a copy +> of this software and associated documentation files (the "Software"), to deal +> in the Software without restriction, including without limitation the rights +> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +> copies of the Software, and to permit persons to whom the Software is +> furnished to do so, subject to the following conditions: +> +> The above copyright notice and this permission notice shall be included in +> all copies or substantial portions of the Software. +> +> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +> THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..e508873a --- /dev/null +++ b/README.md @@ -0,0 +1,119 @@ + +# UNIFONIC notification channel for Laravel + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/unifonic.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/unifonic) +[![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/unifonic/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/unifonic) +[![StyleCI](https://styleci.io/repos/:style_ci_id/shield)](https://styleci.io/repos/:style_ci_id) +[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/:sensio_labs_id.svg?style=flat-square)](https://insight.sensiolabs.com/projects/:sensio_labs_id) +[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/unifonic.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/unifonic) +[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/unifonic/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/unifonic/?branch=master) +[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/unifonic.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/unifonic) + +This package makes it easy to send notifications using [Unifonic Api](https://unifonic.docs.apiary.io/#reference/messages/send) with Laravel 5.5+, 6.x, 7.x and 8.x + + + +## Contents +- [Requierements](#requirements) +- [Installation](#installation) + - [Setting up the Unifonic service](#setting-up-the-Unifonic-service) +- [Usage](#usage) + - [Available Message methods](#available-message-methods) +- [Changelog](#changelog) +- [Testing](#testing) +- [Security](#security) +- [Contributing](#contributing) +- [Credits](#credits) +- [License](#license) + + +## Requierements +- Before start you have to create an account on [Unifonic](https://unifonic.com). + +## Installation + +1. You can install the package via composer: + +``` bash +composer require laravel-notification-channels/unifonic +``` +This package will register itself automatically if your Laravel 5.5+, trough Package auto-discovery. + + +### Setting up the Unifonic service + +Add your Unifonic AppsId to your `config/services.php`: + +```php +// config/services.php +... +'unifonic' => [ + 'appsId' => env('UNIFONIC_APPS_ID'), +], +... +``` + +## Usage + + +Now you can use the channel in your `via()` method inside the notification: + +``` php +use NotificationChannels\Unifonic\UnifonicChannel; +use NotificationChannels\Unifonic\UnifonicMessage; +use Illuminate\Notifications\Notification; + +class InvoicePaid extends Notification +{ + public function via($notifiable) + { + return [UnifonicChannel::class]; + } + + public function toUnifonic($notifiable) + { + return UnifonicMessage::create("Your invoice {$notifiable->order->id} was paid!"); + } +} +``` + +In order to let your Notification know which phone numer you are targeting, add the `routeNotificationForUnifonic` method to your Notifiable model. + +**Important note**: Unifonic requires the recipients phone number to be without `+` like this format. 21267064497 + +```php +// app/Models/User.php +public function routeNotificationForCmsms() +{ + return '21267064497'; +} +``` + + +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Testing + +``` bash +$ composer test +``` + +## Security + +If you discover any security related issues, please email imad@devinweb.com instead of using the issue tracker. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +## Credits + +- [imad](https://github.com/darbaoui) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. diff --git a/composer.json b/composer.json new file mode 100644 index 00000000..60d825f8 --- /dev/null +++ b/composer.json @@ -0,0 +1,49 @@ +{ + "name": "laravel-notification-channels/unifonic", + "description": "Unifonic SMS notification channel for Laravel 5 and up", + "homepage": "https://github.com/laravel-notification-channels/unifonic", + "license": "MIT", + "authors": [ + { + "name": "imad", + "email": "imad@devinweb.com", + "homepage": "https://devinweb.com", + "role": "Developer" + } + ], + "require": { + "php": ">=7.2", + "guzzlehttp/guzzle": "^6.2|^7.0", + "illuminate/notifications": "~5.8 || ~6.0 || ^7.0 || ^8.0", + "illuminate/support": "~5.8 || ~6.0 || ^7.0 || ^8.0", + "orchestra/testbench": "~3.8.0 || ^4.0 || ^5.0 || ^6.0" + }, + "require-dev": { + "mockery/mockery": "^1.0", + "phpunit/phpunit": "^9.0" + }, + "extra": { + "laravel": { + "providers": [ + "NotificationChannels\\Unifonic\\UnifonicServiceProvider" + ] + } + }, + "autoload": { + "psr-4": { + "NotificationChannels\\Unifonic\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "NotificationChannels\\Unifonic\\Test\\": "tests" + } + }, + "scripts": { + "test": "phpunit", + "test:coverage": "phpunit --coverage-text --coverage-clover=coverage.clover" + }, + "config": { + "sort-packages": true + } +} diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 00000000..5f1112bc --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,22 @@ + + + + + tests + + + + + ./app + + + \ No newline at end of file diff --git a/src/Exceptions/CouldNotSendNotification.php b/src/Exceptions/CouldNotSendNotification.php new file mode 100644 index 00000000..355f8189 --- /dev/null +++ b/src/Exceptions/CouldNotSendNotification.php @@ -0,0 +1,11 @@ +client = $client; + } + + + + /** + * Send the given notification. + * + * @param mixed $notifiable + * @param \Illuminate\Notifications\Notification $notification + * + * @throws \NotificationChannels\Unifonic\Exceptions\CouldNotSendNotification + */ + public function send($notifiable, Notification $notification) + { + if (!$recipient = $notifiable->routeNotificationFor('Unifonic')) { + return; + } + + $message = $notification->toUnifonic($notifiable); + + if (is_string($message)) { + $message = UnifonicMessage::create($message); + } + + $this->client->send($message, $recipient); + } +} diff --git a/src/UnifonicClient.php b/src/UnifonicClient.php new file mode 100644 index 00000000..f9af157f --- /dev/null +++ b/src/UnifonicClient.php @@ -0,0 +1,75 @@ +client = $client; + $this->appsId = $appsId; + } + + /** + * @param UnifonicMessage $message + * @param string $recipient + * + * @throws CouldNotSendNotification + */ + + public function send(UnifonicMessage $message, string $recipient) + { + $response = $this->client->request('POST', static::GATEWAY_URL, [ + 'form_params' => $this->buildMessageParameters($message, $recipient), + 'headers' => [ + 'Content-Type' => 'application/x-www-form-urlencoded', + ], + ]); + + $body = $response->getBody()->getContents(); + $array_body = json_decode($body, true); + if (Arr::get($array_body, 'success') === "false") { + throw CouldNotSendNotification::serviceRespondedWithAnError($body); + } + } + + /** + * @param UnifonicMessage $message + * @param string $recipient + * + * @return array $parameters + */ + + private function buildMessageParameters (UnifonicMessage $message, string $recipient): array + { + $mesage_body = $message->getContent(); + $parameters = array_merge(array_filter(['Body' => $mesage_body, 'Recipient' => $recipient]), [ + 'AppSid' => $this->appsId + ]); + + return $parameters; + } + +} diff --git a/src/UnifonicMessage.php b/src/UnifonicMessage.php new file mode 100644 index 00000000..6c30a8af --- /dev/null +++ b/src/UnifonicMessage.php @@ -0,0 +1,59 @@ +body($body); + } + + /** + * @param string $body + * + * @return $this + */ + public function body(string $body) + { + $this->body = trim($body); + + return $this; + } + + + /** + * get the content message + * + * @return string $body + * + */ + public function getContent(): string + { + return $this->body; + } + + /** + * @param string $body + * + * @return static + */ + public static function create($body = ''): self + { + return new static($body); + } + + +} diff --git a/src/UnifonicServiceProvider.php b/src/UnifonicServiceProvider.php new file mode 100644 index 00000000..51bf59b7 --- /dev/null +++ b/src/UnifonicServiceProvider.php @@ -0,0 +1,29 @@ +app->when(UnifonicChannel::class) + ->needs(UnifonicClient::class) + ->give(function () { + if (is_null($appsId = config('services.unifonic.appsId'))) { + throw InvalidConfiguration::configurationNotSet(); + } + return new UnifonicClient(new GuzzleClient(), $appsId); + }); + + + } + +} diff --git a/tests/UnifonicChannelTest.php b/tests/UnifonicChannelTest.php new file mode 100644 index 00000000..c0e65f57 --- /dev/null +++ b/tests/UnifonicChannelTest.php @@ -0,0 +1,72 @@ +notification = new TestNotification(); + $this->notifiable = new TestNotifiable(); + $this->guzzle = Mockery::mock(new Client()); + $this->appsId = '1335b3f7-ba23-4316-b2dd-202448bd8904'; + // Config::set('services.unifonic.appsId', $this->appsId); + $this->client = Mockery::mock(new UnifonicClient($this->guzzle, $this->appsId)); + $this->channel = new UnifonicChannel($this->client); + } + + public function tearDown(): void + { + Mockery::close(); + parent::tearDown(); + } + + /** @test */ + public function it_can_be_instantiated() + { + $this->assertInstanceOf(UnifonicClient::class, $this->client); + $this->assertInstanceOf(UnifonicChannel::class, $this->channel); + } + + /** + * @test + * @doesNotPerformAssertions + */ + public function it_send_message() + { + $this->client->shouldReceive('send')->once(); + $this->channel->send($this->notifiable, $this->notification); + } +} + +class TestNotifiable +{ + use Notifiable; + + public function routeNotificationForUnifonic() + { + return '212679064497'; + } +} + +class TestNotification extends Notification +{ + public function toUnifonic($notifiable) + { + return UnifonicMessage::create('Message content'); + } +} \ No newline at end of file diff --git a/tests/UnifonicClientTest.php b/tests/UnifonicClientTest.php new file mode 100644 index 00000000..7407201e --- /dev/null +++ b/tests/UnifonicClientTest.php @@ -0,0 +1,64 @@ +appsId = '1335b3f7-ba23-4316-b2dd-202448bd8904'; + $this->guzzle =Mockery::mock(new Client()); + $this->client = Mockery::mock(new UnifonicClient($this->guzzle, $this->appsId)); + $this->message = UnifonicMessage::create('Message body'); + } + + public function tearDown(): void + { + Mockery::close(); + parent::tearDown(); + } + + /** @test */ + public function it_can_be_instantiated() + { + $this->assertInstanceOf(UnifonicClient::class, $this->client); + $this->assertInstanceOf(UnifonicMessage::class, $this->message); + } + + /** + * @test + * @doesNotPerformAssertions + */ + public function it_can_send_message() + { + $this->guzzle + ->shouldReceive('request') + ->once() + ->andReturn(new Response(200, [], '')); + $this->client->send($this->message, '212679'); + } + + + /** @test */ + public function it_throws_exception_on_error_response() + { + $this->expectException(CouldNotSendNotification::class); + $this->guzzle + ->shouldReceive('request') + ->once() + ->andReturn(new Response(200, [], '{"success": "false"}')); + $this->client->send($this->message, '212679'); + } +} diff --git a/tests/UnifonicMessageTest.php b/tests/UnifonicMessageTest.php new file mode 100644 index 00000000..c0a126cf --- /dev/null +++ b/tests/UnifonicMessageTest.php @@ -0,0 +1,27 @@ +assertInstanceOf(UnifonicMessage::class, $message); + } + + /** @test */ + public function it_supports_create_method() + { + $message = UnifonicMessage::create('Foo'); + + $this->assertInstanceOf(UnifonicMessage::class, $message); + $this->assertEquals('Foo', $message->getContent()); + } + +} \ No newline at end of file From a84e05b1187945ccdd6d0125e32e58800387a104 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Thu, 31 Dec 2020 19:44:00 +0100 Subject: [PATCH 02/10] fix style ci --- src/Exceptions/InvalidConfiguration.php | 2 +- src/UnifonicChannel.php | 5 +---- src/UnifonicClient.php | 14 +++++--------- src/UnifonicMessage.php | 8 +------- src/UnifonicServiceProvider.php | 6 ++---- tests/UnifonicChannelTest.php | 4 ++-- tests/UnifonicClientTest.php | 8 ++------ tests/UnifonicMessageTest.php | 3 +-- 8 files changed, 15 insertions(+), 35 deletions(-) diff --git a/src/Exceptions/InvalidConfiguration.php b/src/Exceptions/InvalidConfiguration.php index ee25af5b..7d304aaf 100644 --- a/src/Exceptions/InvalidConfiguration.php +++ b/src/Exceptions/InvalidConfiguration.php @@ -10,4 +10,4 @@ public static function configurationNotSet(): self { return new static('In order to send notifications via Unifonic you need to add credentials in the `unifonic` key of `config.services`.'); } -} \ No newline at end of file +} diff --git a/src/UnifonicChannel.php b/src/UnifonicChannel.php index 43848af8..dcd5a68a 100644 --- a/src/UnifonicChannel.php +++ b/src/UnifonicChannel.php @@ -2,7 +2,6 @@ namespace NotificationChannels\Unifonic; -use NotificationChannels\Unifonic\Exceptions\CouldNotSendNotification; use Illuminate\Notifications\Notification; class UnifonicChannel @@ -25,8 +24,6 @@ public function __construct(UnifonicClient $client) $this->client = $client; } - - /** * Send the given notification. * @@ -37,7 +34,7 @@ public function __construct(UnifonicClient $client) */ public function send($notifiable, Notification $notification) { - if (!$recipient = $notifiable->routeNotificationFor('Unifonic')) { + if (! $recipient = $notifiable->routeNotificationFor('Unifonic')) { return; } diff --git a/src/UnifonicClient.php b/src/UnifonicClient.php index f9af157f..d99ad3c4 100644 --- a/src/UnifonicClient.php +++ b/src/UnifonicClient.php @@ -2,23 +2,21 @@ namespace NotificationChannels\Unifonic; -use NotificationChannels\Unifonic\Exceptions\CouldNotSendNotification; use GuzzleHttp\Client as GuzzleClient; use Illuminate\Support\Arr; +use NotificationChannels\Unifonic\Exceptions\CouldNotSendNotification; class UnifonicClient { const GATEWAY_URL = 'https://api.unifonic.com/rest/Messages/Send'; /** - * * @var GuzzleClient * */ protected $client; /** - * - * @var string $appsId + * @var string * */ protected $appsId; @@ -38,7 +36,6 @@ public function __construct(GuzzleClient $client, string $appsId) * * @throws CouldNotSendNotification */ - public function send(UnifonicMessage $message, string $recipient) { $response = $this->client->request('POST', static::GATEWAY_URL, [ @@ -50,7 +47,7 @@ public function send(UnifonicMessage $message, string $recipient) $body = $response->getBody()->getContents(); $array_body = json_decode($body, true); - if (Arr::get($array_body, 'success') === "false") { + if (Arr::get($array_body, 'success') === 'false') { throw CouldNotSendNotification::serviceRespondedWithAnError($body); } } @@ -61,12 +58,11 @@ public function send(UnifonicMessage $message, string $recipient) * * @return array $parameters */ - - private function buildMessageParameters (UnifonicMessage $message, string $recipient): array + private function buildMessageParameters(UnifonicMessage $message, string $recipient): array { $mesage_body = $message->getContent(); $parameters = array_merge(array_filter(['Body' => $mesage_body, 'Recipient' => $recipient]), [ - 'AppSid' => $this->appsId + 'AppSid' => $this->appsId, ]); return $parameters; diff --git a/src/UnifonicMessage.php b/src/UnifonicMessage.php index 6c30a8af..ac1e42c8 100644 --- a/src/UnifonicMessage.php +++ b/src/UnifonicMessage.php @@ -2,7 +2,6 @@ namespace NotificationChannels\Unifonic; - class UnifonicMessage { /** @@ -12,7 +11,6 @@ class UnifonicMessage */ public $body; - /** * @param string $body */ @@ -32,13 +30,11 @@ public function body(string $body) return $this; } - /** - * get the content message + * get the content message. * * @return string $body - * */ public function getContent(): string { @@ -54,6 +50,4 @@ public static function create($body = ''): self { return new static($body); } - - } diff --git a/src/UnifonicServiceProvider.php b/src/UnifonicServiceProvider.php index 51bf59b7..d713fa43 100644 --- a/src/UnifonicServiceProvider.php +++ b/src/UnifonicServiceProvider.php @@ -1,11 +1,12 @@ appsId = '1335b3f7-ba23-4316-b2dd-202448bd8904'; - $this->guzzle =Mockery::mock(new Client()); + $this->guzzle = Mockery::mock(new Client()); $this->client = Mockery::mock(new UnifonicClient($this->guzzle, $this->appsId)); $this->message = UnifonicMessage::create('Message body'); } @@ -50,7 +47,6 @@ public function it_can_send_message() $this->client->send($this->message, '212679'); } - /** @test */ public function it_throws_exception_on_error_response() { diff --git a/tests/UnifonicMessageTest.php b/tests/UnifonicMessageTest.php index c0a126cf..f7cf95e6 100644 --- a/tests/UnifonicMessageTest.php +++ b/tests/UnifonicMessageTest.php @@ -14,7 +14,7 @@ public function it_can_be_instantiated() $this->assertInstanceOf(UnifonicMessage::class, $message); } - + /** @test */ public function it_supports_create_method() { @@ -23,5 +23,4 @@ public function it_supports_create_method() $this->assertInstanceOf(UnifonicMessage::class, $message); $this->assertEquals('Foo', $message->getContent()); } - } \ No newline at end of file From 07560daf5e3617c997fd3c72c13ce61d2a7ab9aa Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Thu, 31 Dec 2020 19:48:29 +0100 Subject: [PATCH 03/10] fix style ci issues --- src/UnifonicClient.php | 3 +-- src/UnifonicMessage.php | 4 ++-- src/UnifonicServiceProvider.php | 1 + tests/UnifonicChannelTest.php | 3 +-- tests/UnifonicMessageTest.php | 2 +- 5 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/UnifonicClient.php b/src/UnifonicClient.php index d99ad3c4..4a2c3492 100644 --- a/src/UnifonicClient.php +++ b/src/UnifonicClient.php @@ -64,8 +64,7 @@ private function buildMessageParameters(UnifonicMessage $message, string $recipi $parameters = array_merge(array_filter(['Body' => $mesage_body, 'Recipient' => $recipient]), [ 'AppSid' => $this->appsId, ]); - + return $parameters; } - } diff --git a/src/UnifonicMessage.php b/src/UnifonicMessage.php index ac1e42c8..7bdfb5e2 100644 --- a/src/UnifonicMessage.php +++ b/src/UnifonicMessage.php @@ -30,10 +30,10 @@ public function body(string $body) return $this; } - + /** * get the content message. - * + * * @return string $body */ public function getContent(): string diff --git a/src/UnifonicServiceProvider.php b/src/UnifonicServiceProvider.php index d713fa43..30f3fc37 100644 --- a/src/UnifonicServiceProvider.php +++ b/src/UnifonicServiceProvider.php @@ -21,6 +21,7 @@ public function boot() if (is_null($appsId = config('services.unifonic.appsId'))) { throw InvalidConfiguration::configurationNotSet(); } + return new UnifonicClient(new GuzzleClient(), $appsId); }); } diff --git a/tests/UnifonicChannelTest.php b/tests/UnifonicChannelTest.php index 8d50424f..a47b782b 100644 --- a/tests/UnifonicChannelTest.php +++ b/tests/UnifonicChannelTest.php @@ -5,11 +5,10 @@ use GuzzleHttp\Client; use Illuminate\Notifications\Notifiable; use Illuminate\Notifications\Notification; -use Illuminate\Support\Facades\Config; use Mockery; -use NotificationChannels\Unifonic\UnifonicMessage; use NotificationChannels\Unifonic\UnifonicChannel; use NotificationChannels\Unifonic\UnifonicClient; +use NotificationChannels\Unifonic\UnifonicMessage; use PHPUnit\Framework\TestCase; class UnifonicChannelTest extends TestCase diff --git a/tests/UnifonicMessageTest.php b/tests/UnifonicMessageTest.php index f7cf95e6..8a14c6b9 100644 --- a/tests/UnifonicMessageTest.php +++ b/tests/UnifonicMessageTest.php @@ -23,4 +23,4 @@ public function it_supports_create_method() $this->assertInstanceOf(UnifonicMessage::class, $message); $this->assertEquals('Foo', $message->getContent()); } -} \ No newline at end of file +} From a4a554c802428e395a4dd3c05a5279fc1d6def4a Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Thu, 31 Dec 2020 19:51:10 +0100 Subject: [PATCH 04/10] fix style ci issues --- src/UnifonicClient.php | 2 +- src/UnifonicServiceProvider.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/UnifonicClient.php b/src/UnifonicClient.php index 4a2c3492..a89e8c22 100644 --- a/src/UnifonicClient.php +++ b/src/UnifonicClient.php @@ -64,7 +64,7 @@ private function buildMessageParameters(UnifonicMessage $message, string $recipi $parameters = array_merge(array_filter(['Body' => $mesage_body, 'Recipient' => $recipient]), [ 'AppSid' => $this->appsId, ]); - + return $parameters; } } diff --git a/src/UnifonicServiceProvider.php b/src/UnifonicServiceProvider.php index 30f3fc37..91f1cd40 100644 --- a/src/UnifonicServiceProvider.php +++ b/src/UnifonicServiceProvider.php @@ -21,7 +21,7 @@ public function boot() if (is_null($appsId = config('services.unifonic.appsId'))) { throw InvalidConfiguration::configurationNotSet(); } - + return new UnifonicClient(new GuzzleClient(), $appsId); }); } From ae6343ef89012bfc0cdd6320b951284efbdf96f9 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Mon, 5 Jul 2021 11:56:17 +0100 Subject: [PATCH 05/10] fix styleci .gitignore --- .gitignore | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 4e62afc2..d07f69a4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ - /vendor build composer.phar composer.lock -.phpunit.result.cache \ No newline at end of file +.phpunit.result.cache From cd0e76e81394bb6613fb2f12c8704c564d737b95 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Mon, 5 Jul 2021 11:59:03 +0100 Subject: [PATCH 06/10] update README.md --- README.md | 46 ++++++++++++++++++++-------------------------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index e508873a..67e33fe5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # UNIFONIC notification channel for Laravel [![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/unifonic.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/unifonic) @@ -12,34 +11,31 @@ This package makes it easy to send notifications using [Unifonic Api](https://unifonic.docs.apiary.io/#reference/messages/send) with Laravel 5.5+, 6.x, 7.x and 8.x - - ## Contents -- [Requierements](#requirements) -- [Installation](#installation) - - [Setting up the Unifonic service](#setting-up-the-Unifonic-service) -- [Usage](#usage) - - [Available Message methods](#available-message-methods) -- [Changelog](#changelog) -- [Testing](#testing) -- [Security](#security) -- [Contributing](#contributing) -- [Credits](#credits) -- [License](#license) +- [Requierements](#requirements) +- [Installation](#installation) + - [Setting up the Unifonic service](#setting-up-the-Unifonic-service) +- [Usage](#usage) + - [Available Message methods](#available-message-methods) +- [Changelog](#changelog) +- [Testing](#testing) +- [Security](#security) +- [Contributing](#contributing) +- [Credits](#credits) +- [License](#license) ## Requierements -- Before start you have to create an account on [Unifonic](https://unifonic.com). + +- Before start you have to create an account on [Unifonic](https://unifonic.com). ## Installation 1. You can install the package via composer: -``` bash +```bash composer require laravel-notification-channels/unifonic ``` -This package will register itself automatically if your Laravel 5.5+, trough Package auto-discovery. - ### Setting up the Unifonic service @@ -56,10 +52,9 @@ Add your Unifonic AppsId to your `config/services.php`: ## Usage - Now you can use the channel in your `via()` method inside the notification: -``` php +```php use NotificationChannels\Unifonic\UnifonicChannel; use NotificationChannels\Unifonic\UnifonicMessage; use Illuminate\Notifications\Notification; @@ -80,24 +75,23 @@ class InvoicePaid extends Notification In order to let your Notification know which phone numer you are targeting, add the `routeNotificationForUnifonic` method to your Notifiable model. -**Important note**: Unifonic requires the recipients phone number to be without `+` like this format. 21267064497 +**Important note**: Unifonic requires the recipients phone number to be [E.164](https://developers.omnisend.com/guides/e164-phone-number-formatting) ```php // app/Models/User.php public function routeNotificationForCmsms() { - return '21267064497'; + return '+21267064497'; } ``` - ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. ## Testing -``` bash +```bash $ composer test ``` @@ -111,8 +105,8 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ## Credits -- [imad](https://github.com/darbaoui) -- [All Contributors](../../contributors) +- [imad](https://github.com/darbaoui) +- [All Contributors](../../contributors) ## License From 5cf38e260bee717d235e68d4cb5bfa08a3283999 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Mon, 5 Jul 2021 12:00:38 +0100 Subject: [PATCH 07/10] update composer.json and Readme.md --- README.md | 2 +- composer.json | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 67e33fe5..964ecb89 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ In order to let your Notification know which phone numer you are targeting, add ```php // app/Models/User.php -public function routeNotificationForCmsms() +public function routeNotificationForUnifonic() { return '+21267064497'; } diff --git a/composer.json b/composer.json index 60d825f8..0d99c7f7 100644 --- a/composer.json +++ b/composer.json @@ -14,8 +14,8 @@ "require": { "php": ">=7.2", "guzzlehttp/guzzle": "^6.2|^7.0", - "illuminate/notifications": "~5.8 || ~6.0 || ^7.0 || ^8.0", - "illuminate/support": "~5.8 || ~6.0 || ^7.0 || ^8.0", + "illuminate/notifications": "~6.0 || ^7.0 || ^8.0", + "illuminate/support": "~6.0 || ^7.0 || ^8.0", "orchestra/testbench": "~3.8.0 || ^4.0 || ^5.0 || ^6.0" }, "require-dev": { @@ -46,4 +46,4 @@ "config": { "sort-packages": true } -} +} \ No newline at end of file From b4daca351800d2317e3a13f6a1fef89bca26e9e5 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Mon, 5 Jul 2021 12:02:09 +0100 Subject: [PATCH 08/10] fix UnifonicClient headers --- src/UnifonicClient.php | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/UnifonicClient.php b/src/UnifonicClient.php index a89e8c22..5f0545cb 100644 --- a/src/UnifonicClient.php +++ b/src/UnifonicClient.php @@ -39,10 +39,7 @@ public function __construct(GuzzleClient $client, string $appsId) public function send(UnifonicMessage $message, string $recipient) { $response = $this->client->request('POST', static::GATEWAY_URL, [ - 'form_params' => $this->buildMessageParameters($message, $recipient), - 'headers' => [ - 'Content-Type' => 'application/x-www-form-urlencoded', - ], + 'form_params' => $this->buildMessageParameters($message, $recipient) ]); $body = $response->getBody()->getContents(); From 8b523ac6e1f3fb7094e7944367f54e467e22bcb2 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Mon, 5 Jul 2021 12:03:39 +0100 Subject: [PATCH 09/10] remove + in the phone number if exist --- src/UnifonicChannel.php | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/UnifonicChannel.php b/src/UnifonicChannel.php index dcd5a68a..9da0d1a3 100644 --- a/src/UnifonicChannel.php +++ b/src/UnifonicChannel.php @@ -44,6 +44,18 @@ public function send($notifiable, Notification $notification) $message = UnifonicMessage::create($message); } + $recipient = $this->unifonicRecipientNumberValidation($recipient); $this->client->send($message, $recipient); } + + /** + * Remove + from the internation phone number + * @param string $recipient + * + * @return string + */ + private function unifonicRecipientNumberValidation($recipient) + { + return preg_replace('/^\+?1|\|1|\D/', '', $recipient); + } } From 8aaf6792c14b1f71dab45bca81d85e4db8b78057 Mon Sep 17 00:00:00 2001 From: darbaoui imad Date: Mon, 5 Jul 2021 12:05:43 +0100 Subject: [PATCH 10/10] fix styleci --- src/UnifonicChannel.php | 2 +- src/UnifonicClient.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/UnifonicChannel.php b/src/UnifonicChannel.php index 9da0d1a3..33a8d923 100644 --- a/src/UnifonicChannel.php +++ b/src/UnifonicChannel.php @@ -49,7 +49,7 @@ public function send($notifiable, Notification $notification) } /** - * Remove + from the internation phone number + * Remove + from the internation phone number. * @param string $recipient * * @return string diff --git a/src/UnifonicClient.php b/src/UnifonicClient.php index 5f0545cb..59bfb4b1 100644 --- a/src/UnifonicClient.php +++ b/src/UnifonicClient.php @@ -39,7 +39,7 @@ public function __construct(GuzzleClient $client, string $appsId) public function send(UnifonicMessage $message, string $recipient) { $response = $this->client->request('POST', static::GATEWAY_URL, [ - 'form_params' => $this->buildMessageParameters($message, $recipient) + 'form_params' => $this->buildMessageParameters($message, $recipient), ]); $body = $response->getBody()->getContents();