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..2ad24a45 --- /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: [ 8.1 ] + + 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..616e6d3b --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +/vendor +build +composer.phar +composer.lock +.DS_Store +.phpunit.result.cache diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100644 index 00000000..db54c400 --- /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..a3bce087 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `pr0gramm` 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..1443ce01 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,63 @@ +# 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..9d5c31fe --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright (c) Marcel Wagner + +> 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..eb6e6422 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,125 @@ -# New Notification Channels +# Pr0gramm Laravel 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/pr0gramm.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/pr0gramm) +[![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/pr0gramm/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/pr0gramm) +[![StyleCI](https://styleci.io/repos/:style_ci_id/shield)](https://styleci.io/repos/:style_ci_id) +[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/pr0gramm.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/pr0gramm) +[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/pr0gramm/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/pr0gramm/?branch=master) +[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/pr0gramm.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/pr0gramm) -### 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 to [Pr0gramm](https://pr0gramm.com/) users with Laravel. -## 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 Pr0gramm service](#setting-up-the-Pr0gramm-service) +- [Usage](#usage) +- [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 laravel-notification-channels/pr0gramm +``` + +Next, you must load the service provider if you don't use auto-discovery: + +```php +// config/app.php +'providers' => [ + // ... + NotificationChannels\Pr0gramm\Pr0grammServiceProvider::class, +], +``` + +### Setting up the Pr0gramm service + +It is recommended to use the credentials of a bot account, as you will not be able to solve the required captcha. You +can read more about the Pr0gramm-API and how to get your credentials [here](https://github.com/pr0gramm-com/api-docs/). + +Next, you must add your Pr0gramm Credentials in `config/services.php`: + +```php +// config/services.php +'pr0gramm' => [ + 'username' => env('PR0GRAMM_USERNAME'), + 'password' => env('PR0GRAMM_PASSWORD'), +], +``` + +## Usage + +In every model you wish to be notifiable via Pr0gramm, you must add a `getPr0grammName` method that returns the name of +the user on Pr0gramm. + +```php +// app/Models/User.php +public function getPr0grammName(): string +{ + return $this->pr0grammName; +} +``` + +You can now use the channel in your `via()` method inside the notification (You can also use `'pr0gramm'` as channel +name)): + +```php +use NotificationChannels\Pr0gramm\Pr0grammChannel; + +public function via($notifiable) +{ + return [Pr0grammChannel::class]; +} +``` + +Next, you must add a `toPr0gramm` method to your notification containing the message you wish to send to the user: + +```php +public function toPr0gramm($notifiable): string +{ + return 'Message from Laravel'; +} +``` + +> **NOTE - RATE LIMIT**: As the rate limit for sending messages is quite low, you will probably run into +> the `Pr0grammRateLimitReached`-Exception. +> +> You can handle this exception through your try catch block or when using the queue driver by adding a `failed`-method +> to your notification and release the job again. + +That's it, you're ready to go! + +## 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 info@marcelwagner.dev instead of using the issue tracker. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +## Credits + +- [Marcel Wagner](https://github.com/Tschucki) +- [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..a42fd1b7 --- /dev/null +++ b/composer.json @@ -0,0 +1,50 @@ +{ + "name": "laravel-notification-channels/pr0gramm", + "description": "Laravel notification driver for Pr0gramm.", + "homepage": "https://github.com/laravel-notification-channels/pr0gramm", + "license": "MIT", + "version": "0.0.1", + "keywords": [ + "laravel", + "notification", + "driver", + "channel", + "pr0gramm" + ], + "authors": [ + { + "name": "Marcel Wagner", + "email": "info@marcelwagner.dev", + "homepage": "https://www.marcelwagner.dev/", + "role": "Developer" + } + ], + "require": { + "php": ">=8.1", + "illuminate/notifications": "^7.0 || ^8.0 || ^9.0 || ^10.0", + "illuminate/support": "^7.0 || ^8.0 || ^9.0 || ^10.0", + "tschucki/laravel-pr0gramm-api": "1.0.4" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^3.46", + "mockery/mockery": "^1.0", + "phpunit/phpunit": "^9.0" + }, + "autoload": { + "psr-4": { + "NotificationChannels\\Pr0gramm\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "NotificationChannels\\Pr0gramm\\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..76608559 --- /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..51fb56fb --- /dev/null +++ b/src/Exceptions/CouldNotSendNotification.php @@ -0,0 +1,33 @@ +toPr0gramm($notifiable); + + if (! is_string($message)) { + throw CouldNotSendNotification::noStringForMessageProvided(); + } + + $response = Pr0grammApi::Inbox()->post($message, $notifiable->getPr0grammName()); + + if ($response->failed()) { + throw CouldNotSendNotification::serviceRespondedWithAnError($response->body()); + } + + if ($response->status() === 429) { + throw Pr0grammRateLimitReached::rateLimitReached(); + } + } +} diff --git a/src/Pr0grammServiceProvider.php b/src/Pr0grammServiceProvider.php new file mode 100644 index 00000000..f5504912 --- /dev/null +++ b/src/Pr0grammServiceProvider.php @@ -0,0 +1,27 @@ +app->when(Pr0grammChannel::class) + ->needs(Pr0grammApi::class) + ->give(function () { + return Pr0grammApi::class; + }); + } + + public function register(): void + { + Notification::resolved(static function (ChannelManager $service) { + $service->extend('pr0gramm', static fn ($app) => $app->make(Pr0grammChannel::class)); + }); + } +} diff --git a/tests/Pr0grammTest.php b/tests/Pr0grammTest.php new file mode 100644 index 00000000..4c1549df --- /dev/null +++ b/tests/Pr0grammTest.php @@ -0,0 +1,14 @@ +assertTrue(true); + } +}