From 5208ca04580d3986577af33500ab01ca865290cc Mon Sep 17 00:00:00 2001 From: nicko170 Date: Fri, 28 May 2021 17:11:10 +1000 Subject: [PATCH 1/3] initial release --- .editorconfig | 15 ++ .gitattributes | 10 + .github/workflows/tests.yml | 32 +++ .gitignore | 7 + .scrutinizer.yml | 21 ++ .styleci.yml | 1 + CHANGELOG.md | 7 + CONTRIBUTING.md | 55 +++++ LICENSE.md | 21 ++ README.md | 130 ++++++++++- composer.json | 50 ++++ config/expo.php | 12 + phpunit.xml.dist | 29 +++ src/Exceptions/CouldNotSendNotification.php | 113 +++++++++ src/ExpoChannel.php | 84 +++++++ src/ExpoMessage.php | 246 ++++++++++++++++++++ src/ExpoServiceProvider.php | 38 +++ tests/ExpoChannelTest.php | 47 ++++ tests/ExpoMessageTest.php | 96 ++++++++ tests/Notifiable.php | 16 ++ tests/NotifiableArray.php | 16 ++ tests/TestCase.php | 24 ++ tests/TestNotification.php | 17 ++ 23 files changed, 1075 insertions(+), 12 deletions(-) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .github/workflows/tests.yml create mode 100644 .gitignore create mode 100644 .scrutinizer.yml create mode 100644 .styleci.yml create mode 100755 CHANGELOG.md create mode 100755 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 composer.json create mode 100644 config/expo.php create mode 100644 phpunit.xml.dist create mode 100644 src/Exceptions/CouldNotSendNotification.php create mode 100644 src/ExpoChannel.php create mode 100644 src/ExpoMessage.php create mode 100644 src/ExpoServiceProvider.php create mode 100644 tests/ExpoChannelTest.php create mode 100644 tests/ExpoMessageTest.php create mode 100644 tests/Notifiable.php create mode 100644 tests/NotifiableArray.php create mode 100644 tests/TestCase.php create mode 100644 tests/TestNotification.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/.gitattributes b/.gitattributes new file mode 100644 index 00000000..b2638710 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,10 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.gitattributes export-ignore +/.gitignore export-ignore +/.travis.yml export-ignore +/phpunit.xml.dist export-ignore +/.scrutinizer.yml export-ignore +/tests export-ignore diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 00000000..fda9079b --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,32 @@ +name: PHPUnit tests + +on: + - push + - pull_request + +jobs: + tests: + runs-on: ubuntu-latest + strategy: + fail-fast: true + matrix: + php: [7.4, 8.0] + + name: Tests on PHP ${{ matrix.php }} - ${{ matrix.stability }} + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + tools: composer:v2 + coverage: none + + - name: Install dependencies + run: composer update --prefer-source --no-interaction --no-progress + + - name: Execute tests + run: vendor/bin/phpunit --verbose diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..cb67e9e6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +/vendor +build +composer.phar +composer.lock +.DS_Store +.phpunit.result.cache +.idea diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100644 index 00000000..6fad5be9 --- /dev/null +++ b/.scrutinizer.yml @@ -0,0 +1,21 @@ +filter: + excluded_paths: [tests/*] + +checks: + php: + remove_extra_empty_lines: true + remove_php_closing_tag: true + remove_trailing_whitespace: true + fix_use_statements: + remove_unused: true + preserve_multiple: false + preserve_blanklines: true + order_alphabetically: true + fix_php_opening_tag: true + fix_linefeed: true + fix_line_ending: true + fix_identation_4spaces: true + fix_doc_comments: true + +tools: + external_code_coverage: true 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..7d2bda6e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `expo` will be documented in this file + +## 1.0.0 - 2021-05-29 + +- 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..29e08b17 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright (c) Nick Pratley + +> 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..334d840d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,123 @@ -# New Notification Channels +# Expo Push Notifications Channel -### 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/laravel-notification-channels/expo.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/expo) +[![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/expo/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/expo) +[![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/expo.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/expo) +[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/expo/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/expo/?branch=master) +[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/expo.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/expo) -### 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 [Expo](https://docs.expo.io/push-notifications/overview/) with Laravel 8.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) + - [Setting up the Expo service](#setting-up-the-Expo-service) +- [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 + +Install this package with Composer: + + composer require laravel-notification-channels/expo + +### Setting up the Expo service + +If you use an [Expo Access Token](https://docs.expo.io/push-notifications/sending-notifications/#additional-security) please set this in your environment. + + EXPO_ACCESS_TOKEN=mysecrettoken + +## Usage +Firstly you will need to define a method to retrieve your Expo push token +````php +class NotifiableModel extends Model { + // You may pass a single token + public function routeNotificationForExpo($notification) + { + return "ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]" + } + + // Or you may return an array of tokens, for example, a user could have multiple devices. + public function routeNotificationForExpo($notification) + { + return $this->installations->pluck('expo_token')->toArray() + } +} +```` + + +````php +message = $message; + } + + public function via($notifiable) + { + return [ExpoChannel::class]; + } + + public function toExpo($notifiable) + { + return ExpoMessage::create() + ->title("New Message from {$this->message->from}!") + ->body($this->message->text) + ->badge(1); + } +} +```` + +### Available Message methods + + + +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Testing + +TODO + +## Security + +If you discover any security related issues, please email nick@npratley.net instead of using the issue tracker. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +## Credits + +- [Nick Pratley](https://github.com/nicko170) +- [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..f10c7d5d --- /dev/null +++ b/composer.json @@ -0,0 +1,50 @@ +{ + "name": "laravel-notification-channels/expo", + "description": "Expo Notifications driver for Laravel", + "homepage": "https://github.com/laravel-notification-channels/expo", + "license": "MIT", + "authors": [ + { + "name": "Nick Pratley", + "email": "nick@npratley.net", + "homepage": "https://devlan.io/", + "role": "Developer" + } + ], + "require": { + "php": ">=7.4 | ^8.0", + "ext-json": "*", + "guzzlehttp/guzzle": "^7.3", + "illuminate/notifications": "~6.0 || ~7.0 || ~8.0", + "illuminate/support": "~6.0 || ~7.0 || ~8.0" + }, + "require-dev": { + "mockery/mockery": "^1.0", + "orchestra/testbench": "^6.18", + "phpunit/phpunit": "^8.0" + }, + "autoload": { + "psr-4": { + "NotificationChannels\\Expo\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "NotificationChannels\\Expo\\Test\\": "tests" + } + }, + "scripts": { + "test": "phpunit", + "test:coverage": "phpunit --coverage-text --coverage-clover=coverage.clover" + }, + "config": { + "sort-packages": true + }, + "extra" : { + "laravel": { + "providers": [ + "NotificationChannels\\Expo\\ExpoServiceProvider" + ] + } + } +} diff --git a/config/expo.php b/config/expo.php new file mode 100644 index 00000000..e4b2e8de --- /dev/null +++ b/config/expo.php @@ -0,0 +1,12 @@ + env('EXPO_ACCESS_TOKEN', null), +]; diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 00000000..b11febb6 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,29 @@ + + + + + tests + + + + + src/ + + + + + + + + + + diff --git a/src/Exceptions/CouldNotSendNotification.php b/src/Exceptions/CouldNotSendNotification.php new file mode 100644 index 00000000..24dec784 --- /dev/null +++ b/src/Exceptions/CouldNotSendNotification.php @@ -0,0 +1,113 @@ +getBody()->getContents().'`'); + } + + /** + * Thrown on a generic error. + * + * @param mixed $notification + * @return static + */ + public static function genericMessage($message) + { + return new static($message); + } + + /** + * Thrown if a notification instance does not implement a toExpo() method, but is + * attempting to be delivered via the Expo notification channel. + * + * @param mixed $notification + * @return static + */ + public static function undefinedMethod($notification) + { + return new static( + 'Notification of class: ' . get_class($notification) + . ' must define a `toExpo()` method in order to send via Expo' + ); + } + + /** + * Thrown if a notification instance's `toExpo()` method, + * does not return an instance of `\NotificationChannels\Expo\ExpoMessage` + * + * @param mixed $notification + * @return static + */ + public static function couldNotCreateMessage($notification) + { + return new static( + 'Notification of class: ' . get_class($notification) + . ' `toExpo()` method did not return an instance of `\NotificationChannels\Expo\ExpoMessage`' + ); + } + + /** + * Thrown if a notifiable instance's `routeNotificationFor` method does not return a + * valid Expo push token. + * + * @param mixed $notifiable + * @return static + */ + public static function noValidDestination($notifiable) + { + return new static( + 'Notifiable of class: ' . get_class($notifiable) + . ' `routeNotificationFor()` method did not return a valid Expo Push Token' + ); + } + + /** + * Thrown if a 400-level Http error was encountered whilst attempting to deliver the + * notification. + * + * @param ClientException $exception + * @return static + */ + public static function clientError(ClientException $exception) + { + if (! $exception->hasResponse()) { + return new static('Expo responded with an error but no response body was available'); + } + + $statusCode = $exception->getResponse()->getStatusCode(); + $description = $exception->getMessage(); + + return new static( + "Failed to send Expo notification, encountered client error: `{$statusCode} - {$description}`" + ); + } + + /** + * Thrown if an unexpected exception was encountered whilst attempting to deliver the + * notification. + * + * @param Exception $exception + * @return static + */ + public static function unexpectedException(Exception $exception) + { + return new static( + 'Failed to send Expo notification, unexpected exception encountered: `'.$exception->getMessage().'`', + 0, + $exception + ); + } +} diff --git a/src/ExpoChannel.php b/src/ExpoChannel.php new file mode 100644 index 00000000..fb7990a2 --- /dev/null +++ b/src/ExpoChannel.php @@ -0,0 +1,84 @@ +client = $client; + } + + /** + * Send the given notification. + * + * @param mixed $notifiable + * @param Notification $notification + * + * @throws CouldNotSendNotification|GuzzleException + */ + public function send($notifiable, Notification $notification) + { + if (! ($to = $notifiable->routeNotificationFor('expo'))) { + throw CouldNotSendNotification::noValidDestination($notifiable); + } + + if (! method_exists($notification, 'toExpo')) { + throw CouldNotSendNotification::undefinedMethod($notification); + } + + /** @var ExpoMessage $message */ + if (! ($message = $notification->toExpo($notification)) instanceof ExpoMessage) { + throw CouldNotSendNotification::couldNotCreateMessage($notification); + } + + if(!is_array($to)){ + $to = [$to]; + } + + $messages = array_map( + function ($recipient) use ($message) { + return array_merge(['to' => $recipient], $message->toArray()); + }, + $to + ); + + try { + $response = $this->client->request( + 'post', + 'https://exp.host/--/api/v2/push/send', + ['json' => $messages] + ); + + if ($response->getStatusCode() !== 200) { + throw CouldNotSendNotification::serviceRespondedWithAnError($response); + } + + return $response; + + } catch (ClientException $exception) { + throw CouldNotSendNotification::clientError($exception); + } catch (Exception $exception) { + throw CouldNotSendNotification::unexpectedException($exception); + } + } +} diff --git a/src/ExpoMessage.php b/src/ExpoMessage.php new file mode 100644 index 00000000..afb3e732 --- /dev/null +++ b/src/ExpoMessage.php @@ -0,0 +1,246 @@ +title = $title; + $this->body = $body; + } + + /** + * Set the message title. + * + * @param string $value + * + * @return $this + */ + public function title(string $value): ExpoMessage + { + $this->title = $value; + + return $this; + } + + /** + * Set the message body. + * + * @param string $value + * + * @return $this + */ + public function body(string $value): ExpoMessage + { + $this->body = $value; + + return $this; + } + + /** + * Enable the message sound. + * + * @return $this + */ + public function enableSound(): ExpoMessage + { + $this->sound = 'default'; + + return $this; + } + + /** + * Disable the message sound. + * + * @return $this + */ + public function disableSound(): ExpoMessage + { + $this->sound = null; + + return $this; + } + + /** + * Set the message badge (iOS). + * + * @param int $value + * + * @return $this + */ + public function badge(int $value): ExpoMessage + { + $this->badge = $value; + + return $this; + } + + /** + * Set the time to live of the notification. + * + * @param int $ttl + * + * @return $this + */ + public function setTtl(int $ttl): ExpoMessage + { + $this->ttl = $ttl; + + return $this; + } + + /** + * Set the channelId of the notification for Android devices. + * + * @param string $channelId + * + * @return $this + */ + public function setChannelId(string $channelId): ExpoMessage + { + $this->channelId = $channelId; + + return $this; + } + + /** + * Set the json Data attached to the message. + * + * @param array|string $data + * + * @return $this + * + * @throws CouldNotSendNotification + */ + public function setJsonData($data): ExpoMessage + { + if (is_array($data)) { + $data = json_encode($data); + } elseif (is_string($data)) { + @json_decode($data); + + if (json_last_error() !== JSON_ERROR_NONE) { + throw CouldNotSendNotification::genericMessage('Invalid json format passed to setJsonData().'); + } + } + + $this->jsonData = $data; + + return $this; + } + + /** + * Set the priority of the notification, must be one of [default, normal, high]. + * + * @param string $priority + * + * @return $this + */ + public function priority(string $priority): ExpoMessage + { + $this->priority = $priority; + + return $this; + } + + /** + * Get an array representation of the message. + * + * @return array + */ + public function toArray(): array + { + $message = [ + 'title' => $this->title, + 'body' => $this->body, + 'sound' => $this->sound, + 'badge' => $this->badge, + 'ttl' => $this->ttl, + 'data' => $this->jsonData, + 'priority' => $this->priority, + ]; + if (! empty($this->channelId)) { + $message['channelId'] = $this->channelId; + } + + return $message; + } +} diff --git a/src/ExpoServiceProvider.php b/src/ExpoServiceProvider.php new file mode 100644 index 00000000..9bf3047b --- /dev/null +++ b/src/ExpoServiceProvider.php @@ -0,0 +1,38 @@ +app->when(ExpoChannel::class) + ->needs(GuzzleClient::class) + ->give(function () { + $accessToken = config('expo.access_token'); + if($accessToken) { + return new GuzzleClient(['headers' => ['Authorization' => "Bearer $accessToken"]]); + }else{ + return new GuzzleClient(); + } + }); + + $this->publishes([ + realpath(__DIR__.'/../config/expo.php') => config_path('expo.php'), + ], 'config'); + } + + /** + * Register the application services. + */ + public function register() + { + $this->mergeConfigFrom(realpath(__DIR__.'/../config/expo.php'), 'expo'); + } +} diff --git a/tests/ExpoChannelTest.php b/tests/ExpoChannelTest.php new file mode 100644 index 00000000..895efc10 --- /dev/null +++ b/tests/ExpoChannelTest.php @@ -0,0 +1,47 @@ + 'application/json'], '{"data":{"status":"ok","id":"0b1c6dbf-77c9-4b9a-b037-33cc8b297c9a"}}'), + ]); + $handlerStack = HandlerStack::create($mock); + $guzzle = new Client(['handler' => $handlerStack]); + + $channel = new ExpoChannel($guzzle); + + $response = $channel->send(new Notifiable(), new TestNotification()); + $json = json_decode($response->getBody()); + $this->assertTrue($json->data->status === 'ok'); + } + + /** @test */ + public function can_send_notification_to_notifible_array() + { + $mock = new MockHandler([ + new Response(200, ['Content-Type' => 'application/json'], '{"data":[{"id":"e74c5f71-c9f0-4dcb-95b9-3dd6bc8d4b0f","status":"ok"},{"status":"ok","id":"d46deba0-1b77-482e-bb29-af2331b7b8d8"}]}'), + ]); + $handlerStack = HandlerStack::create($mock); + $guzzle = new Client(['handler' => $handlerStack]); + + $channel = new ExpoChannel($guzzle); + + $response = $channel->send(new Notifiable(), new TestNotification()); + $json = json_decode($response->getBody()); + $this->assertTrue($json->data[0]->status === 'ok'); + $this->assertTrue($json->data[1]->status === 'ok'); + } + +} diff --git a/tests/ExpoMessageTest.php b/tests/ExpoMessageTest.php new file mode 100644 index 00000000..bb740f11 --- /dev/null +++ b/tests/ExpoMessageTest.php @@ -0,0 +1,96 @@ +message = new ExpoMessage(); + } + + /** @test */ + public function it_can_accept_a_title_when_constrictung_a_message(){ + $message = new ExpoMessage("Title"); + $this->assertEquals("Title", Arr::get($message->toArray(), 'title')); + } + + /** @test */ + public function it_can_accept_a_body_when_constrictung_a_message(){ + $message = new ExpoMessage("", "Body"); + $this->assertEquals("Body", Arr::get($message->toArray(), 'body')); + } + + /** @test */ + public function it_provides_a_create_method(){ + $message = ExpoMessage::create('Title'); + $this->assertEquals("Title", Arr::get($message->toArray(), 'title')); + } + + /** @test */ + public function it_can_set_the_title(){ + $this->message->title('Title'); + $this->assertEquals("Title", Arr::get($this->message->toArray(), 'title')); + } + + /** @test */ + public function it_can_set_the_body(){ + $this->message->body('Body'); + $this->assertEquals("Body", Arr::get($this->message->toArray(), 'body')); + } + + /** @test */ + public function it_can_enable_sound(){ + $this->message->enableSound(); + $this->assertEquals("default", Arr::get($this->message->toArray(), 'sound')); + } + + /** @test */ + public function it_can_disable_sound(){ + $this->message->disableSound(); + $this->assertEquals(null, Arr::get($this->message->toArray(), 'sound')); + } + + /** @test */ + public function it_can_set_the_badge(){ + $this->message->badge(9); + $this->assertEquals(9, Arr::get($this->message->toArray(), 'badge')); + } + + /** @test */ + public function it_can_set_the_ttl(){ + $this->message->setTtl(50); + $this->assertEquals(50, Arr::get($this->message->toArray(), 'ttl')); + } + + /** @test */ + public function it_can_set_the_channelId(){ + $this->message->setChannelId('Channel Name'); + $this->assertEquals('Channel Name', Arr::get($this->message->toArray(), 'channelId')); + } + + /** @test */ + public function it_can_set_the_json_data_as_array(){ + $this->message->setJsonData(['json' => 'data']); + $this->assertEquals('{"json":"data"}', Arr::get($this->message->toArray(), 'data')); + } + + /** @test */ + public function it_can_set_the_json_data_as_string(){ + $this->message->setJsonData('{"json":"string"}'); + $this->assertEquals('{"json":"string"}', Arr::get($this->message->toArray(), 'data')); + } + + /** @test */ + public function it_can_set_the_priority(){ + $this->message->priority('low'); + $this->assertEquals('low', Arr::get($this->message->toArray(), 'priority')); + } + +} diff --git a/tests/Notifiable.php b/tests/Notifiable.php new file mode 100644 index 00000000..67c27bd0 --- /dev/null +++ b/tests/Notifiable.php @@ -0,0 +1,16 @@ +title('Title') + ->body('Body') + ->badge(1); + } +} From 0f273cba248513161589457731e0d1d3b2b119ad Mon Sep 17 00:00:00 2001 From: nicko170 Date: Fri, 11 Jun 2021 02:48:15 +0000 Subject: [PATCH 2/3] downgrade guzzle and fix readme --- README.md | 2 +- composer.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 334d840d..9d175ddb 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recen ## Testing -TODO + $ composer test ## Security diff --git a/composer.json b/composer.json index f10c7d5d..ff888221 100644 --- a/composer.json +++ b/composer.json @@ -14,7 +14,7 @@ "require": { "php": ">=7.4 | ^8.0", "ext-json": "*", - "guzzlehttp/guzzle": "^7.3", + "guzzlehttp/guzzle": "~6.0", "illuminate/notifications": "~6.0 || ~7.0 || ~8.0", "illuminate/support": "~6.0 || ~7.0 || ~8.0" }, From 2cf5a5fda0b4ef7fe49249fbb3d99eedd245bafe Mon Sep 17 00:00:00 2001 From: nicko170 Date: Fri, 11 Jun 2021 12:54:32 +1000 Subject: [PATCH 3/3] styleci fixes --- config/expo.php | 2 +- src/Exceptions/CouldNotSendNotification.php | 16 +++--- src/ExpoChannel.php | 9 ++-- src/ExpoMessage.php | 1 + src/ExpoServiceProvider.php | 4 +- tests/ExpoChannelTest.php | 2 - tests/ExpoMessageTest.php | 59 +++++++++++++-------- 7 files changed, 52 insertions(+), 41 deletions(-) diff --git a/config/expo.php b/config/expo.php index e4b2e8de..898fdd27 100644 --- a/config/expo.php +++ b/config/expo.php @@ -3,7 +3,7 @@ return [ /** * Additional Security - * https://docs.expo.io/push-notifications/sending-notifications/#additional-security + * https://docs.expo.io/push-notifications/sending-notifications/#additional-security. * * If you have this enabled, please set your access token below. If you have not enabled this feature * you may leave this as null. diff --git a/src/Exceptions/CouldNotSendNotification.php b/src/Exceptions/CouldNotSendNotification.php index 24dec784..0926e945 100644 --- a/src/Exceptions/CouldNotSendNotification.php +++ b/src/Exceptions/CouldNotSendNotification.php @@ -8,7 +8,7 @@ class CouldNotSendNotification extends \Exception { /** - * Expo responded with an error + * Expo responded with an error. * * @param $response * @return static @@ -39,14 +39,14 @@ public static function genericMessage($message) public static function undefinedMethod($notification) { return new static( - 'Notification of class: ' . get_class($notification) - . ' must define a `toExpo()` method in order to send via Expo' + 'Notification of class: '.get_class($notification) + .' must define a `toExpo()` method in order to send via Expo' ); } /** * Thrown if a notification instance's `toExpo()` method, - * does not return an instance of `\NotificationChannels\Expo\ExpoMessage` + * does not return an instance of `\NotificationChannels\Expo\ExpoMessage`. * * @param mixed $notification * @return static @@ -54,8 +54,8 @@ public static function undefinedMethod($notification) public static function couldNotCreateMessage($notification) { return new static( - 'Notification of class: ' . get_class($notification) - . ' `toExpo()` method did not return an instance of `\NotificationChannels\Expo\ExpoMessage`' + 'Notification of class: '.get_class($notification) + .' `toExpo()` method did not return an instance of `\NotificationChannels\Expo\ExpoMessage`' ); } @@ -69,8 +69,8 @@ public static function couldNotCreateMessage($notification) public static function noValidDestination($notifiable) { return new static( - 'Notifiable of class: ' . get_class($notifiable) - . ' `routeNotificationFor()` method did not return a valid Expo Push Token' + 'Notifiable of class: '.get_class($notifiable) + .' `routeNotificationFor()` method did not return a valid Expo Push Token' ); } diff --git a/src/ExpoChannel.php b/src/ExpoChannel.php index fb7990a2..b32c8743 100644 --- a/src/ExpoChannel.php +++ b/src/ExpoChannel.php @@ -3,11 +3,11 @@ namespace NotificationChannels\Expo; use Exception; -use GuzzleHttp\Exception\GuzzleException; -use NotificationChannels\Expo\Exceptions\CouldNotSendNotification; use GuzzleHttp\Client; use GuzzleHttp\Exception\ClientException; +use GuzzleHttp\Exception\GuzzleException; use Illuminate\Notifications\Notification; +use NotificationChannels\Expo\Exceptions\CouldNotSendNotification; class ExpoChannel { @@ -51,14 +51,14 @@ public function send($notifiable, Notification $notification) throw CouldNotSendNotification::couldNotCreateMessage($notification); } - if(!is_array($to)){ + if (! is_array($to)) { $to = [$to]; } $messages = array_map( function ($recipient) use ($message) { return array_merge(['to' => $recipient], $message->toArray()); - }, + }, $to ); @@ -74,7 +74,6 @@ function ($recipient) use ($message) { } return $response; - } catch (ClientException $exception) { throw CouldNotSendNotification::clientError($exception); } catch (Exception $exception) { diff --git a/src/ExpoMessage.php b/src/ExpoMessage.php index afb3e732..3449a2d9 100644 --- a/src/ExpoMessage.php +++ b/src/ExpoMessage.php @@ -1,6 +1,7 @@ needs(GuzzleClient::class) ->give(function () { $accessToken = config('expo.access_token'); - if($accessToken) { + if ($accessToken) { return new GuzzleClient(['headers' => ['Authorization' => "Bearer $accessToken"]]); - }else{ + } else { return new GuzzleClient(); } }); diff --git a/tests/ExpoChannelTest.php b/tests/ExpoChannelTest.php index 895efc10..479c8614 100644 --- a/tests/ExpoChannelTest.php +++ b/tests/ExpoChannelTest.php @@ -10,7 +10,6 @@ class ExpoChannelTest extends TestCase { - /** @test */ public function can_send_notification_to_notifible() { @@ -43,5 +42,4 @@ public function can_send_notification_to_notifible_array() $this->assertTrue($json->data[0]->status === 'ok'); $this->assertTrue($json->data[1]->status === 'ok'); } - } diff --git a/tests/ExpoMessageTest.php b/tests/ExpoMessageTest.php index bb740f11..c7e7254d 100644 --- a/tests/ExpoMessageTest.php +++ b/tests/ExpoMessageTest.php @@ -5,7 +5,8 @@ use Illuminate\Support\Arr; use NotificationChannels\Expo\ExpoMessage; -class ExpoMessageTest extends \PHPUnit\Framework\TestCase { +class ExpoMessageTest extends \PHPUnit\Framework\TestCase +{ /** @var \NotificationChannels\Expo\ExpoMessage */ protected $message; @@ -16,81 +17,93 @@ public function setUp(): void } /** @test */ - public function it_can_accept_a_title_when_constrictung_a_message(){ - $message = new ExpoMessage("Title"); - $this->assertEquals("Title", Arr::get($message->toArray(), 'title')); + public function it_can_accept_a_title_when_constrictung_a_message() + { + $message = new ExpoMessage('Title'); + $this->assertEquals('Title', Arr::get($message->toArray(), 'title')); } /** @test */ - public function it_can_accept_a_body_when_constrictung_a_message(){ - $message = new ExpoMessage("", "Body"); - $this->assertEquals("Body", Arr::get($message->toArray(), 'body')); + public function it_can_accept_a_body_when_constrictung_a_message() + { + $message = new ExpoMessage('', 'Body'); + $this->assertEquals('Body', Arr::get($message->toArray(), 'body')); } /** @test */ - public function it_provides_a_create_method(){ + public function it_provides_a_create_method() + { $message = ExpoMessage::create('Title'); - $this->assertEquals("Title", Arr::get($message->toArray(), 'title')); + $this->assertEquals('Title', Arr::get($message->toArray(), 'title')); } /** @test */ - public function it_can_set_the_title(){ + public function it_can_set_the_title() + { $this->message->title('Title'); - $this->assertEquals("Title", Arr::get($this->message->toArray(), 'title')); + $this->assertEquals('Title', Arr::get($this->message->toArray(), 'title')); } /** @test */ - public function it_can_set_the_body(){ + public function it_can_set_the_body() + { $this->message->body('Body'); - $this->assertEquals("Body", Arr::get($this->message->toArray(), 'body')); + $this->assertEquals('Body', Arr::get($this->message->toArray(), 'body')); } /** @test */ - public function it_can_enable_sound(){ + public function it_can_enable_sound() + { $this->message->enableSound(); - $this->assertEquals("default", Arr::get($this->message->toArray(), 'sound')); + $this->assertEquals('default', Arr::get($this->message->toArray(), 'sound')); } /** @test */ - public function it_can_disable_sound(){ + public function it_can_disable_sound() + { $this->message->disableSound(); $this->assertEquals(null, Arr::get($this->message->toArray(), 'sound')); } /** @test */ - public function it_can_set_the_badge(){ + public function it_can_set_the_badge() + { $this->message->badge(9); $this->assertEquals(9, Arr::get($this->message->toArray(), 'badge')); } /** @test */ - public function it_can_set_the_ttl(){ + public function it_can_set_the_ttl() + { $this->message->setTtl(50); $this->assertEquals(50, Arr::get($this->message->toArray(), 'ttl')); } /** @test */ - public function it_can_set_the_channelId(){ + public function it_can_set_the_channelId() + { $this->message->setChannelId('Channel Name'); $this->assertEquals('Channel Name', Arr::get($this->message->toArray(), 'channelId')); } /** @test */ - public function it_can_set_the_json_data_as_array(){ + public function it_can_set_the_json_data_as_array() + { $this->message->setJsonData(['json' => 'data']); $this->assertEquals('{"json":"data"}', Arr::get($this->message->toArray(), 'data')); } /** @test */ - public function it_can_set_the_json_data_as_string(){ + public function it_can_set_the_json_data_as_string() + { $this->message->setJsonData('{"json":"string"}'); $this->assertEquals('{"json":"string"}', Arr::get($this->message->toArray(), 'data')); } /** @test */ - public function it_can_set_the_priority(){ + public function it_can_set_the_priority() + { $this->message->priority('low'); $this->assertEquals('low', Arr::get($this->message->toArray(), 'priority')); } - }