Refactor NotifierMailTest and NotifierDiscordTest

ewilan-riviere · ewilan-riviere · commit 26842cb409ca · 2024-02-08T17:29:07.000+01:00
diff --git a/README.md b/README.md
@@ -44,6 +44,10 @@ This is the contents of the published config file:
 
 ```php
 return [
+    // Default notifier client to send HTTP request, can be `stream`, `curl` or `guzzle`.
+    // `guzzle` is not included in this package, you need to install it manually.
+    'client' => env('NOTIFIER_CLIENT', 'stream'),
+
     'discord' => [
         // Default Discord webhook URL.
         'webhook' => env('NOTIFIER_DISCORD_WEBHOOK', null),
diff --git a/config/notifier.php b/config/notifier.php
@@ -1,6 +1,10 @@
 <?php
 
 return [
+    // Default notifier client to send HTTP request, can be `stream`, `curl` or `guzzle`.
+    // `guzzle` is not included in this package, you need to install it manually.
+    'client' => env('NOTIFIER_CLIENT', 'stream'),
+
     'discord' => [
         // Default Discord webhook URL.
         'webhook' => env('NOTIFIER_DISCORD_WEBHOOK', null),
diff --git a/src/Notifier/Discord/NotifierDiscordContainer.php b/src/Notifier/Discord/NotifierDiscordContainer.php
@@ -2,6 +2,7 @@
 
 namespace Kiwilan\Notifier\Notifier\Discord;
 
+use Illuminate\Support\Facades\Log;
 use Kiwilan\Notifier\Utils\NotifierRequest;
 
 abstract class NotifierDiscordContainer
@@ -30,6 +31,12 @@ public function send(): static
 
         $this->isSuccess = $this->request->getStatusCode() === 204;
 
+        if ($this->isSuccess) {
+            Log::error("Notifier: discord notification failed with HTTP {$this->request->getStatusCode()}", [
+                $this->request->toArray(),
+            ]);
+        }
+
         return $this;
     }
 }
diff --git a/src/Notifier/NotifierSlack.php b/src/Notifier/NotifierSlack.php
@@ -25,70 +25,11 @@ public function message(array|string $message): self
         return $this;
     }
 
-    /**
-     * Prepare message for sending.
-     */
-    private function createBody(): self
-    {
-        $this->requestData = [
-            'text' => $this->message ?? '',
-        ];
-
-        return $this;
-    }
-
     public function send(): bool
     {
-        $this->createBody();
-        // $spatie->message($this->message);
-        // $spatie->blocks([
-        //     [
-        //         'type' => 'section',
-        //         'text' => [
-        //             'type' => 'mrkdwn',
-        //             'text' => $this->message,
-        //         ],
-        //     ],
-        // ]);
-        // // $payload = $this->text
-        // //     ? ['type' => 'mrkdwn', 'text' => $this->text]
-        // //     : ['blocks' => $this->blocks];
-
-        // // if ($this->channel) {
-        // //     $payload['channel'] = $this->channel;
-        // // }
-
-        // // Http::post($this->webhookUrl, $payload)->throw();
-        // $this->request = NotifierRequest::make($this->webhook)
-        //     // ->requestData([
-        //     //     'type' => 'mrkdwn',
-        //     //     'text' => 'Hello, Slack!',
-        //     // ])
-        //     ->requestData([
-        //         'blocks' => [
-        //             [
-        //                 'type' => 'section',
-        //                 'text' => [
-        //                     'type' => 'mrkdwn',
-        //                     'text' => 'Danny Torrence left the following review for your property:',
-        //                 ],
-        //             ],
-        //             [
-        //                 'type' => 'section',
-        //                 'block_id' => 'section567',
-        //                 'text' => [
-        //                     'type' => 'mrkdwn',
-        //                     'text' => "<https://example.com|Overlook Hotel> \n :star: \n Doors had too many axe holes, guest in room 237 was far too rowdy, whole place felt stuck in the 1920s.",
-        //                 ],
-        //                 'accessory' => [
-        //                     'type' => 'image',
-        //                     'image_url' => 'https://is5-ssl.mzstatic.com/image/thumb/Purple3/v4/d3/72/5c/d3725c8f-c642-5d69-1904-aa36e4297885/source/256x256bb.jpg',
-        //                     'alt_text' => 'Haunted hotel image',
-        //                 ],
-        //             ],
-        //         ],
-        //     ])
-        //     ->send();
+        $this->request = NotifierRequest::make($this->webhook)
+            ->requestData($this->toArray())
+            ->send();
 
         if ($this->request->getStatusCode() !== 200) {
             $this->logError("status code {$this->request->getStatusCode()}", [
@@ -104,9 +45,7 @@ public function send(): bool
     public function toArray(): array
     {
         return [
-            'webhook' => $this->webhook,
-            'message' => $this->message,
-            'request' => $this->request->toArray(),
+            'text' => $this->message ?? '',
         ];
     }
 }
diff --git a/src/Notifier/Slack/NotifierSlackContainer.php b/src/Notifier/Slack/NotifierSlackContainer.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Kiwilan\Notifier\Notifier\Slack;
+
+use Illuminate\Support\Facades\Log;
+use Kiwilan\Notifier\Utils\NotifierRequest;
+
+abstract class NotifierSlackContainer
+{
+    protected function __construct(
+        protected ?string $webhook = null,
+        protected ?NotifierRequest $request = null,
+        protected bool $isSuccess = false,
+    ) {
+    }
+
+    abstract public static function create(string $webhook, string $description): self;
+
+    abstract public function toArray(): array;
+
+    public function isSuccess(): bool
+    {
+        return $this->isSuccess;
+    }
+
+    public function send(): static
+    {
+        $this->request = NotifierRequest::make($this->webhook)
+            ->requestData($this->toArray())
+            ->send();
+
+        $this->isSuccess = $this->request->getStatusCode() === 200;
+
+        if ($this->isSuccess) {
+            Log::error("Notifier: slack notification failed with HTTP {$this->request->getStatusCode()}", [
+                $this->request->toArray(),
+            ]);
+        }
+
+        return $this;
+    }
+}
diff --git a/src/Notifier/Slack/NotifierSlackMessage.php b/src/Notifier/Slack/NotifierSlackMessage.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Kiwilan\Notifier\Notifier\Slack;
+
+class NotifierSlackMessage extends NotifierSlackContainer
+{
+    protected function __construct(
+        protected ?string $message = null,
+        protected ?string $username = null,
+        protected ?string $avatarUrl = null,
+    ) {
+    }
+
+    public static function create(string $webhook, string $message): self
+    {
+        if (strlen($message) > 2000) {
+            $message = substr($message, 0, 1980).'...';
+        }
+
+        $self = new self($message);
+        $self->webhook = $webhook;
+
+        return $self;
+    }
+
+    public function user(string $username, ?string $avatarUrl = null): self
+    {
+        $this->username = $username;
+
+        if ($avatarUrl) {
+            $this->avatarUrl = $avatarUrl;
+        }
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        $data = [];
+
+        if ($this->username) {
+            $data['username'] = $this->username;
+        }
+
+        if ($this->avatarUrl) {
+            $data['avatar_url'] = $this->avatarUrl;
+        }
+
+        $data['content'] = $this->message ?? 'Empty message.';
+
+        return $data;
+    }
+}
diff --git a/src/Utils/NotifierRequest.php b/src/Utils/NotifierRequest.php
@@ -7,6 +7,7 @@ class NotifierRequest
     protected function __construct(
         protected string $url,
         protected string $mode = 'stream',
+        protected bool $modeAuto = true,
         protected array $headers = [],
         protected array $request_data = [],
         protected ?array $response_body = [],
@@ -32,6 +33,7 @@ public static function make(string $url)
     public function useStream(): self
     {
         $this->mode = 'stream';
+        $this->modeAuto = false;
 
         return $this;
     }
@@ -42,6 +44,7 @@ public function useStream(): self
     public function useCurl(): self
     {
         $this->mode = 'curl';
+        $this->modeAuto = false;
 
         return $this;
     }
@@ -52,6 +55,7 @@ public function useCurl(): self
     public function useGuzzle(): self
     {
         $this->mode = 'guzzle';
+        $this->modeAuto = false;
 
         return $this;
     }
@@ -103,6 +107,10 @@ public function asForm(): self
     public function send(): self
     {
         try {
+            if ($this->modeAuto) {
+                $this->mode = config('notifier.client');
+            }
+
             if ($this->mode === 'stream') {
                 $this->stream();
             } elseif ($this->mode === 'curl') {
diff --git a/tests/NotifierDiscordTest.php b/tests/NotifierDiscordTest.php
@@ -19,7 +19,30 @@
     expect($facade)->toBeInstanceOf(NotifierNotifier::class);
 });
 
-it('can use discord', function () {
+it('can use clients', function () {
+    Config::set('notifier.client', 'stream');
+
+    $notifier = Notifier::discord()
+        ->message('Hello, Discord!')
+        ->send();
+    expect($notifier->isSuccess())->toBeTrue();
+
+    Config::set('notifier.client', 'curl');
+
+    $notifier = Notifier::discord()
+        ->message('Hello, Discord!')
+        ->send();
+    expect($notifier->isSuccess())->toBeTrue();
+
+    Config::set('notifier.client', 'guzzle');
+
+    $notifier = Notifier::discord()
+        ->message('Hello, Discord!')
+        ->send();
+    expect($notifier->isSuccess())->toBeTrue();
+});
+
+it('can use', function () {
     $notifier = Notifier::discord()
         ->message('Hello, Discord!')
         ->user('Notifier', 'https://raw.githubusercontent.com/kiwilan/notifier-laravel/main/docs/banner.jpg')
diff --git a/tests/NotifierMailTest.php b/tests/NotifierMailTest.php
@@ -17,7 +17,7 @@
     Config::set('notifier.mail.to.name', dotenv()['NOTIFIER_MAIL_TO_NAME']);
 });
 
-it('can use mail', function () {
+it('can use', function () {
     $notifier = Notifier::mail()
         ->subject('Hello, Mail!')
         ->message('Hello, Mail!')
diff --git a/tests/NotifierSlackTest.php b/tests/NotifierSlackTest.php

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ class NotifierRequest`
`7`	`7`	`protected function __construct(`
`8`	`8`	`protected string $url,`
`9`	`9`	`protected string $mode = 'stream',`
	`10`	`+ protected bool $modeAuto = true,`
`10`	`11`	`protected array $headers = [],`
`11`	`12`	`protected array $request_data = [],`
`12`	`13`	`protected ?array $response_body = [],`
`@@ -32,6 +33,7 @@ public static function make(string $url)`
`32`	`33`	`public function useStream(): self`
`33`	`34`	`{`
`34`	`35`	`$this->mode = 'stream';`
	`36`	`+ $this->modeAuto = false;`
`35`	`37`
`36`	`38`	`return $this;`
`37`	`39`	`}`
`@@ -42,6 +44,7 @@ public function useStream(): self`
`42`	`44`	`public function useCurl(): self`
`43`	`45`	`{`
`44`	`46`	`$this->mode = 'curl';`
	`47`	`+ $this->modeAuto = false;`
`45`	`48`
`46`	`49`	`return $this;`
`47`	`50`	`}`
`@@ -52,6 +55,7 @@ public function useCurl(): self`
`52`	`55`	`public function useGuzzle(): self`
`53`	`56`	`{`
`54`	`57`	`$this->mode = 'guzzle';`
	`58`	`+ $this->modeAuto = false;`
`55`	`59`
`56`	`60`	`return $this;`
`57`	`61`	`}`
`@@ -103,6 +107,10 @@ public function asForm(): self`
`103`	`107`	`public function send(): self`
`104`	`108`	`{`
`105`	`109`	`try {`
	`110`	`+ if ($this->modeAuto) {`
	`111`	`+ $this->mode = config('notifier.client');`
	`112`	`+ }`
	`113`	`+`
`106`	`114`	`if ($this->mode === 'stream') {`
`107`	`115`	`$this->stream();`
`108`	`116`	`} elseif ($this->mode === 'curl') {`