Ntfy

.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: [8.2,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: composer test tests

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+composer.lock
+vendor/

.styleci.yml

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

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `ntfy` 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) Cengiz Onkal <[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,89 @@
-# 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.
+# Ntfy
 
-### 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 [ntfy](https://ntfy.sh/) with Laravel 10
 
-## 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 ntfy service](#setting-up-the-ntfy-service)
+- [Usage](#usage)
+    - [Available Message methods](#available-message-methods)
+- [Testing](#testing)
+- [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/ntfy
+```
+```php
+// config/services.php
+'providers' => [
+    // ...
+    NotificationChannels\Ntfy\NtfyServiceProvider::class,
+],
+```
+
+### Setting up the ntfy service
+
+Configure ntft service in `config/boardcasting.php`:
+
+```php
+ 'ntfy' => [
+            'driver' => 'ntfy',
+            'host' => env('NTFY_HOST'),
+            'port' => env('NTFY_PORT'),
+            'username' => env('NTFY_USERNAME'),
+            'password' => env('NTFY_PASSWORD'),
+        ],
+```
+## Usage
+
+Now you can use the channel in your `via()` method inside the notification:
+
+```php
+ public function via(object $notifiable): array
+    {
+        return [NtfyChannel::class];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     */
+    public function toNtfy(object $notifiable)
+    {
+       return (new NtfyMessage())
+           ->topic('test')
+            ->title('Test Notification')
+            ->body('This is a test notification from Ntfy');
+    }
+```
+
+### Available Message methods
+
+- `topic('')`: Accepts a string value for the topic of the notification.
+- `title('')`: Accepts a string value for the title of the notification.
+- `body('')`: Accepts a string value for the body of the notification.
+- `priority('')`: Accepts a string value for the priority of the notification.(1=Min priority, 2=Low priority, 3=Default priority, 4=High priority, 5=Max priority)
+- 
+
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+## Credits
+
+- [Cengiz Onkal](https://github.com/cengizonkal)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,41 @@
+{
+    "name": "laravel-notification-channels/ntfy",
+    "description": "Laravel notification channel for Ntfy",
+    "homepage": "https://github.com/laravel-notification-channels/ntfy",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Cengiz Onkal",
+            "email": "[email protected]",
+            "homepage": "https://github.com/cengizonkal",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=8.1",
+        "guzzlehttp/guzzle": "^7.8",
+        "illuminate/notifications": "^10.0",
+        "illuminate/support": "^10.0"
+    },
+    "require-dev": {
+        "mockery/mockery": "^1.0",
+        "phpunit/phpunit": "^9.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "NotificationChannels\\Ntfy\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "NotificationChannels\\Ntfy\\Test\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "phpunit",
+        "test:coverage": "phpunit --coverage-text --coverage-clover=coverage.clover"
+    },
+    "config": {
+        "sort-packages": true
+    }
+}

src/Exceptions/CouldNotSendNotification.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace NotificationChannels\Ntfy\Exceptions;
+
+class CouldNotSendNotification extends \Exception
+{
+    public static function serviceRespondedWithAnError($response)
+    {
+        return new static($response);
+    }
+
+    public static function missingNtfyMethod()
+    {
+        return new static('Notification is missing toNtfy() method.');
+    }
+}

src/Ntfy.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace NotificationChannels\Ntfy;
+
+use NotificationChannels\Ntfy\Exceptions\CouldNotSendNotification;
+
+class Ntfy
+{
+    private $host;
+    private $username;
+    private $password;
+    private $topic;
+    private $client;
+    private $port;
+
+    public function __construct($host, $port, $username, $password)
+    {
+        $this->host = $host;
+        $this->username = $username;
+        $this->password = $password;
+        $this->client = new \GuzzleHttp\Client();
+        $this->port = $port;
+    }
+
+    public function send(NtfyMessage $message)
+    {
+        try {
+            $response = $this->client->post($this->host.':'.$this->port, [
+                'auth' => [$this->username, $this->password],
+                'headers' => [
+                    'Content-Type' => 'application/json',
+                    'Accept' => 'application/json',
+                ],
+                'json' => [
+                    'topic' => $message->topic,
+                    'message' => $message->content,
+                    'title' => $message->title,
+                    'priority' => $message->priority,
+                    'tags' => [],
+                    'attach' => '',
+                    'filename' => '',
+                    'click' => '',
+                    'actions' => [],
+                ],
+            ]);
+        } catch (\Exception $e) {
+            throw new CouldNotSendNotification($e);
+        }
+
+        return $response;
+    }
+}

src/NtfyChannel.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace NotificationChannels\Ntfy;
+
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Ntfy\Exceptions\CouldNotSendNotification;
+
+class NtfyChannel
+{
+    private $service;
+
+    public function __construct(Ntfy $service)
+    {
+        $this->service = $service;
+    }
+
+    /**
+     * Send the given notification.
+     *
+     * @param  mixed  $notifiable
+     * @param  \Illuminate\Notifications\Notification  $notification
+     *
+     * @throws \NotificationChannels\Ntfy\Exceptions\CouldNotSendNotification
+     */
+    public function send($notifiable, Notification $notification)
+    {
+        //make sure that the $notification object has a toNtfy() method
+        if (! method_exists($notification, 'toNtfy')) {
+            throw CouldNotSendNotification::missingNtfyMethod();
+        }
+        $this->service->send($notification->toNtfy($notifiable));
+    }
+}