Infomaniak's kChat Notification Channel

.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

.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.3, 7.4, 8.0, 8.1, 8.2]
+
+    name: Tests on PHP ${{ matrix.php }} - ${{ matrix.stability }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - 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

.gitignore

@@ -0,0 +1,8 @@
+/vendor
+build
+composer.phar
+composer.lock
+.DS_Store
+.phpunit.result.cache
+.vscode
+.idea

.styleci.yml

@@ -0,0 +1 @@
+preset: laravel

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `kchat` will be documented in this file
+
+## 1.0.0 - 201X-XX-XX
+
+- initial release

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) karac web Sàrl <[email protected]>
+
+> 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,126 @@
-# New Notification Channels
+Please see [this repo](https://github.com/laravel-notification-channels/channels) for instructions on how to submit a channel proposal.
 
-### Suggesting a new channel
-Have a suggestion or working on a new channel? Please create a new issue for that service.
+# Infomaniak's kChat Notifications Channel for Laravel
 
-### 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 [kChat](https://www.infomaniak.com/en/kchat) with Laravel 5.5+, 6.x, 7.x, 8.x, 9.x, 10.x
 
-## Workflow for new channels
+This package leverages Infomaniak's public API to send notification to [kChat](https://www.infomaniak.com/en/kchat) channels with Laravel 5.5+, 6.x, 7.x, 8.x, 9.x and 10.x
 
-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.
+```php
+return KChatMessage::create()
+    ->to("123456789")
+    ->content('The backup of your application succeeded')
+    ->commentTo('987654321');
+```
 
-Take a look at our [FAQ](http://laravel-notification-channels.com/) to see our small list of rules, to provide top-notch notification channels.
+## Contents
+
+- [Installation](#installation)
+	- [Setting up the kChat service](#setting-up-the-kchat-service)
+- [Usage](#usage)
+	- [Available Message methods](#available-message-methods)
+- [Changelog](#changelog)
+- [Testing](#testing)
+- [Security](#security)
+- [Contributing](#contributing)
+- [Credits](#credits)
+- [License](#license)
+
+
+## Installation
+
+You can install the package via composer:
+
+``` bash
+composer require laravel-notification-channels/kchat
+```
+
+Next, if you're using Laravel _without_ auto-discovery, add the service provider to `config/app.php`:
+
+```bash
+'providers' => [
+    // ...
+    NotificationChannels\KChat\KChatServiceProvider::class,
+],
+```
+
+### Setting up the kChat service
+
+* [Create a token with the scope `kchat`](https://manager.infomaniak.com/v3/ng/accounts/token/add)
+* Retrieve the Url of your kChat instance, it should look like `https://your-team.kchat.infomaniak.com`.
+* Paste the token and your kChat base Url in your `config/services.php` file:
+  ```
+  // config/services.php
+  'infomaniak_kchat' => [
+      'token' => 'YOUR_API_TOKEN',
+      'base_url' => 'https://your-team.kchat.infomaniak.com' 
+  ],
+  ```
+
+## Usage
+
+Now you can use the channel in your `via()` method inside the notification:
+
+```php
+use Illuminate\Notifications\Notification;
+use NotificationChannels\KChat\KChatChannel;
+use NotificationChannels\KChat\KChatMessage;
+
+class BackupSucceeded extends Notification
+{
+    public function via($notifiable)
+    {
+        return [KChatChannel::class];
+    }
+
+    public function toKChat($notifiable)
+    {
+        return KChatMessage::create()
+            ->to("123456789")
+            ->content('The backup of your application succeeded')
+            ->commentTo('987654321'); // A post ID you wish to respond to
+    }
+}
+```
+
+
+Instead of using the `to($channel_id)` method for specifying the channel ID you can also add the `routeNotificationForKChat` method inside your Notifiable model. This method needs to return the channel ID.
+
+```php
+public function routeNotificationForKChat(Notification $notification)
+{
+    return '123456789';
+}
+```
+
+### Available Message methods
+
+- `to(string $channel_id)`: The channel to send the message to.
+- `content(string $content)`: Content of the message (Markdown supported).
+- `commentTo(string $post_id)`: A post ID you wish to respond to.
+
+## 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
+
+- [karac web Sàrl](https://karac.ch)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,49 @@
+{
+    "name": "laravel-notification-channels/kchat",
+    "description": "A Laravel Notification Channel for Infomaniak's kChat",
+    "homepage": "https://github.com/laravel-notification-channels/kchat",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "karac web Sàrl",
+            "email": "[email protected]",
+            "homepage": "https://karac.ch",
+            "role": "Agency"
+        }
+    ],
+    "require": {
+        "ext-json": "*",
+        "php": ">=7.3",
+        "guzzlehttp/guzzle": "^6.3 || ^7.0",
+        "illuminate/notifications": "~6.0 || ~7.0 || ~8.0 || ~9.0 || ~10.0",
+        "illuminate/support": "~6.0 || ~7.0 || ~8.0 || ~9.0 || ~10.0"
+    },
+    "require-dev": {
+        "mockery/mockery": "^1.0",
+        "phpunit/phpunit": "^9.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "NotificationChannels\\KChat\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "NotificationChannels\\KChat\\Test\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "phpunit",
+        "test:coverage": "phpunit --coverage-text --coverage-clover=coverage.clover"
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "NotificationChannels\\KChat\\KChatServiceProvider"
+            ]
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+        <report>
+            <clover outputFile="build/logs/clover.xml"/>
+            <html outputDirectory="build/coverage"/>
+            <text outputFile="build/coverage.txt"/>
+        </report>
+    </coverage>
+    <testsuites>
+        <testsuite name="kChat Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <logging>
+        <junit outputFile="build/report.junit.xml"/>
+    </logging>
+</phpunit>

src/Exceptions/CouldNotSendNotification.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace NotificationChannels\KChat\Exceptions;
+
+use GuzzleHttp\Exception\ClientException;
+
+class CouldNotSendNotification extends \Exception
+{
+    public static function kChatRespondedWithAnError(ClientException $exception)
+    {
+        if (! $exception->hasResponse()) {
+            return new static('kChat responded with an error but no response body found');
+        }
+
+        $statusCode = $exception->getResponse()->getStatusCode();
+        $description = $exception->getMessage();
+
+        return new static("kChat responded with an error `{$statusCode} - {$description}`");
+    }
+
+    public static function couldNotCommunicateWithkChat(\Exception $exception)
+    {
+        return new static("The communication with kChat failed. `{$exception->getMessage()}`");
+    }
+
+    public static function baseUrlMissing()
+    {
+        return new static('The base Url of your kChat instance is missing. Please add it in your config/services.php file.');
+    }
+
+    public static function channelMissing()
+    {
+        return new static('The channel ID you wish to send the notification to is missing.');
+    }
+
+    public static function messageMissing()
+    {
+        return new static('The message is missing.');
+    }
+}