ZenviaSMS notifications channel for Laravel

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to `Zenvia` will be documented in this file
+
+## 1.0.0 - 2023-08-19
+
+- initial release
+
+## 1.0.1 - 2023-08-21
+
+- First stable version

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**!

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) :author_name <:author_email>
+
+> 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.

README.md

@@ -1,17 +1,115 @@
-# New Notification Channels
+# Zenvia notifications channel for Laravel
 
-### Suggesting a new channel
-Have a suggestion or working on a new channel? Please create a new issue for that service.
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/guiigaspar/laravel-zenvia-channel.svg?style=flat-square)](https://packagist.org/packages/guiigaspar/laravel-zenvia-channel)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![Total Downloads](https://img.shields.io/packagist/dt/guiigaspar/laravel-zenvia-channel.svg?style=flat-square)](https://packagist.org/packages/guiigaspar/laravel-zenvia-channel)
 
-### I'm working on a new channel
-Please create an issue for it if it does not already exist, then PR you code for review.
+This package makes it easy to send notifications using [Zenvia](https://zenviasms.docs.apiary.io) with Laravel 7.x, 8.x, 9.x, 10.x
 
-## Workflow for new channels
+## Contents
 
-1) Head over to the [skeleton repo](https://github.com/laravel-notification-channels/skeleton) download a ZIP copy. This is important, to ensure you start from a fresh commit history.
-2) Use find/replace to replace all of the placeholders with the correct values (package name, author name, email, etc).
-3) Implement to logic for the channel & add tests.
-4) Fork this repo, add it as a remote and push your new channel to a branch.
-5) Submit a new PR against this repo for review.
+- [Installation](#installation)
+    - [Configuration](#configuration)
+    - [Advanced Configuration](#advanced-configuration)
+- [Usage](#usage)
+	- [Available Message methods](#available-message-methods)
+- [Changelog](#changelog)
+- [Testing](#testing)
+- [Security](#security)
+- [Contributing](#contributing)
+- [Credits](#credits)
+- [License](#license)
 
-Take a look at our [FAQ](http://laravel-notification-channels.com/) to see our small list of rules, to provide top-notch notification channels.
+
+## Installation
+
+You can install the package via composer:
+
+``` bash
+composer require guiigaspar/laravel-zenvia-channel
+```
+
+### Configuration
+
+Add your Zenvia Account, Password, and From Name (optional) to your `.env`:
+
+```dotenv
+ZENVIA_ACCOUNT=XYZ
+ZENVIA_PASSWORD=XYZ
+ZENVIA_FROM=XYZ # optional
+```
+
+### Advanced Configuration
+
+Run `php artisan vendor:publish --provider="NotificationChannels\LaravelZenviaChannel\ZenviaServiceProvider"`
+```
+/config/zenvia-notification-channel.php
+```
+
+## Usage
+
+Now you can use the channel in your `via()` method inside the notification:
+
+``` php
+use NotificationChannels\LaravelZenviaChannel\ZenviaChannel;
+use NotificationChannels\LaravelZenviaChannel\ZenviaSmsMessage;
+use Illuminate\Notifications\Notification;
+
+class AccountApproved extends Notification
+{
+    public function via($notifiable)
+    {
+        return [ZenviaChannel::class];
+    }
+
+    public function toZenvia($notifiable)
+    {
+        return (new ZenviaSmsMessage())
+            ->content("Your order {$notifiable->orderId} was approved!");
+    }
+}
+```
+
+In order to let your Notification know which phone are you sending/calling to, the channel will look for the `phone_number` attribute of the Notifiable model. If you want to override this behaviour, add the `routeNotificationForZenvia` method to your Notifiable model.
+
+```php
+public function routeNotificationForZenvia()
+{
+    return '+5511912345678';
+}
+```
+
+### Available Message methods
+
+#### ZenviaSmsMessage
+
+- `id('')`: Accepts a ID to use as the notification identifier.
+- `content('')`: Accepts a string value for the notification body.
+- `schedule('')`: Accepts a string value for the notification schedule.
+
+## 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 [email protected] instead of using the issue tracker.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Credits
+
+- [Guilherme Gaspar](https://github.com/guiigaspar)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,55 @@
+{
+    "name": "guiigaspar/laravel-zenvia-channel",
+    "description": "Provides Zenvia notification channel for Laravel",
+    "keywords": [
+        "laravel",
+        "zenvia",
+        "notification",
+        "sms"
+    ],
+    "homepage": "https://github.com/guiigaspar/laravel-zenvia-channel",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Guilherme Gaspar",
+            "email": "[email protected]",
+            "homepage": "https://github.com/guiigaspar",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^8.1",
+        "guzzlehttp/guzzle": "^7.0",
+        "illuminate/notifications": "^7.0 || ^8.0 || ^9.0 || ^10.0",
+        "illuminate/support": "^7.0 || ^8.0 || ^9.0 || ^10.0"
+    },
+    "require-dev": {
+        "mockery/mockery": "^1.0",
+        "phpunit/phpunit": "^9.0",
+        "orchestra/testbench": "^5.0 || ^6.0 || ^7.0 || ^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "NotificationChannels\\LaravelZenviaChannel\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "NotificationChannels\\LaravelZenviaChannel\\Test\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "phpunit",
+        "test:coverage": "phpunit --coverage-text --coverage-clover=coverage.clover"
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "NotificationChannels\\LaravelZenviaChannel\\ZenviaServiceProvider"
+            ]
+        }
+    }
+}

config/zenvia-notification-channel.php

@@ -0,0 +1,7 @@
+<?php
+
+return [
+    'account'  => env('ZENVIA_ACCOUNT'),
+    'password' => env('ZENVIA_PASSWORD'),
+    'from'     => env('ZENVIA_FROM'),
+];

src/Enums/CallbackOptionEnum.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace NotificationChannels\LaravelZenviaChannel\Enums;
+
+enum CallbackOptionEnum: string
+{
+    case OPTION_ALL = 'ALL';
+    case OPTION_FINAL = 'FINAL';
+    case OPTION_NONE = 'NONE';
+}

src/Exceptions/CouldNotSendNotification.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace NotificationChannels\LaravelZenviaChannel\Exceptions;
+
+use GuzzleHttp\Exception\ClientException;
+use NotificationChannels\LaravelZenviaChannel\ZenviaMessage;
+
+class CouldNotSendNotification extends \Exception
+{
+    public static function invalidMessageObject($message): self
+    {
+        $className = is_object($message) ? get_class($message) : 'Unknown';
+
+        return new static(
+            "Notification was not sent. Message object class `{$className}` is invalid. It should
+            be either `".ZenviaMessage::class.'`');
+    }
+
+    public static function invalidReceiver(): self
+    {
+        return new static(
+            'The notifiable did not have a receiving phone number. Add a routeNotificationForZenvia method or a phone_number attribute to your notifiable.'
+        );
+    }
+
+    public static function contentNotProvided(): self
+    {
+        return new static(
+            'Sms content not provided'
+        );
+    }
+
+    public static function serviceConnectionError(): self
+    {
+        return new static(
+            'Could not connect with Zenvia Service'
+        );
+    }
+
+    /**
+     * Thrown when there's a bad request and an error is responded.
+     *
+     * @param ClientException $exception
+     *
+     * @return static
+     */
+    public static function serviceRespondedWithAnError(ClientException $exception): self
+    {
+        $statusCode = $exception->getResponse()->getStatusCode();
+        $description = 'no description given';
+
+        if ($result = json_decode($exception->getResponse()->getBody())) {
+            $description = $result->description ?: $description;
+        }
+
+        return new static(
+            "Zenvia responded with an error `{$statusCode} - {$description}`"
+        );
+    }
+}

src/Exceptions/InvalidConfigException.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NotificationChannels\LaravelZenviaChannel\Exceptions;
+
+class InvalidConfigException extends \Exception
+{
+    public static function missingConfig(): self
+    {
+        return new self('Missing config. You must set either the account and password');
+    }
+}