diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..2659611c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +composer.lock diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..2710bbe0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `signal` will be documented in this file + +## 0.0.1 - 2020-07-31 + +- First release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9a9b8eeb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **encouraged** 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..19a7de77 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright (c) CJ Barlow + +> 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 index fa8362b7..66581c0c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,95 @@ -# New Notification Channels +## Signal notification channel for Laravel -### Suggesting a new channel -Have a suggestion or working on a new channel? Please create a new issue for that service. +Easily send end-to-end encrypted notifications for Laravel using [Signal](https://signal.org). -### 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. +## Contents -## Workflow for new channels +- [Installation](#installation) + - [Setting up the Signal service](#setting-up-the-Signal-service) +- [Usage](#usage) + - [Available Message methods](#available-message-methods) +- [Changelog](#changelog) +- [Testing](#testing) +- [Security](#security) +- [Contributing](#contributing) +- [Credits](#credits) +- [License](#license) -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. -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 +1) Set up signal-cli + +This package requires [`signal-cli`](https://github.com/AsamK/signal-cli) to communicate with the Signal service. Precompiled binaries are available [here](https://github.com/AsamK/signal-cli/releases/latest). + +Extract the binary file to a directory of your choice. Signal-cli requires JRE 7 or newer. + +2) Set your signal-cli and JAVA_HOME paths in SignalChannel. + +3) Register your phone number (username) with the Signal service: +``` bash +./signal-cli --username +12345556789 register +``` + +Add your phone number (username) to `.env`: +```dotenv +SIGNAL_USERNAME="+12345556789" # Prefix ("+") and country code are required. +``` + +## Usage + +```//... +use NotificationChannels\Signal\SignalChannel; +use NotificationChannels\Signal\SignalMessage; +use Illuminate\Notifications\Notification; + +class AccountCreated extends Notification +{ + use Queueable; + + public function via($notifiable) + { + return [SignalChannel::class]; + } + + public function toSignal($notifiable) + { + return (new SignalMessage()) + ->message("This is a test Laravel notification message over Signal.") + ->recipient("+12345556789"); + } +``` + +Notifications will be sent to the `recipient` attribute of the Notifiable model. + +### Available Message methods + +`message 'string'` + +`recipient 'string'` + +## 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 cjbarlow@protonmail.com instead of using the issue tracker. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +## Credits + +- [CJ Barlow](https://github.com/tehCh0nG) +- [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..5d085e24 --- /dev/null +++ b/composer.json @@ -0,0 +1,40 @@ +{ + "name": "laravel-notification-channels/signal", + "description": "Provides notifications over Signal", + "homepage": "https://github.com/laravel-notification-channels/signal", + "license": "MIT", + "authors": [ + { + "name": "CJ Barlow", + "email": "cjbarlow@protonmail.com", + "homepage": "https://github.com/laravel-notification-channels/signal", + "role": "Developer" + } + ], + "require": { + "php": ">=7.2", + "illuminate/notifications": "~5.5 || ~6.0 || ~7.0", + "illuminate/support": "~5.5 || ~6.0 || ~7.0" + }, + "require-dev": { + "mockery/mockery": "^1.0", + "phpunit/phpunit": "^9" + }, + "autoload": { + "psr-4": { + "NotificationChannels\\Signal\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "NotificationChannels\\Signal\\Test\\": "tests" + } + }, + "scripts": { + "test": "phpunit", + "test:coverage": "phpunit --coverage-text --coverage-clover=coverage.clover" + }, + "config": { + "sort-packages": true + } +} diff --git a/config/signal-notification-channel.php b/config/signal-notification-channel.php new file mode 100644 index 00000000..09d402b8 --- /dev/null +++ b/config/signal-notification-channel.php @@ -0,0 +1,15 @@ + env('SIGNAL_USERNAME'), + 'java_home' => env('JAVA_HOME'), + + /** + * Path to signal_cli binary file + **/ + 'signal_cli' => env('SIGNAL_CLI_LOCATION'), +] diff --git a/src/Exceptions/CouldNotSendNotification.php b/src/Exceptions/CouldNotSendNotification.php new file mode 100644 index 00000000..b37398ac --- /dev/null +++ b/src/Exceptions/CouldNotSendNotification.php @@ -0,0 +1,12 @@ +sender => config('signal-notification-channel.username'); + } +} diff --git a/src/SignalChannel.php b/src/SignalChannel.php new file mode 100644 index 00000000..ed38ad47 --- /dev/null +++ b/src/SignalChannel.php @@ -0,0 +1,54 @@ +toSignal($notifiable)); + + $recipient = $collection->get('recipient'); + $message = $collection->get('message'); + + //Run signal-cli via Symfony Process. + $result = new Process( + [config('signal-notification-channel.signal_cli'), + '--username',config('signal-notification-channel.username'), + 'send','--message',$message, + $recipient], + //Pass JAVA_HOME to Symfony so signal-cli can run. + null, + ['JAVA_HOME' => config('signal-notification-channel.java_location')] + ); + + $result->run(); + + if (!$result->isSuccessful()) { + throw new ProcessFailedException($result); + } + + return $result; + } +} diff --git a/src/SignalMessage.php b/src/SignalMessage.php new file mode 100644 index 00000000..1b66c754 --- /dev/null +++ b/src/SignalMessage.php @@ -0,0 +1,82 @@ +message = string $message; + } + + /** + * Set the message. + * + * @param string $message + * + * @return $this + */ + public function message(string $message) + { + $this->message = string $message; + + return $this; + } + + /** + * Set the phone number the message should be sent to. + * + * @param string $recipient + * + * @return $this + */ + public function recipient(string $recipient) + { + $this->recipient = string $recipient; + + return $this; + } + + /** + * + * The phone number of the recipient. + * Must include prefix ("+") and country code. + * + * @var string + **/ + public $recipient; +} diff --git a/src/tests/MessageTest.php b/src/tests/MessageTest.php new file mode 100644 index 00000000..025fb272 --- /dev/null +++ b/src/tests/MessageTest.php @@ -0,0 +1,49 @@ +message = new SignalMessage(); + } + + public function provides_a_create_method() + { + $message = SignalMessage::create(); + + $this->assertInstanceOf(SignalMessage::class, $message); + } + + public function sets_username() + { + $this->message->username('+12345556789'); + + $this->assertEquals('+12345556789', $this->message->username); + } + + public function sets_recipient() + { + $this->message->recipient('+12345556789'); + + $this->assertEquals('+12345556789', $this->message->recipient); + } + + public function sets_message() + { + $this->message('Test message'); + + $this->assertEquals('Test message', $this->message); + } + +}