Merge pull request #2 from YieldStudio/support-laravel-11

feat: Add support for Laravel 11

.github/workflows/styling.yml

@@ -8,15 +8,18 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.head_ref }}
-
-      - name: Run PHP CS Fixer
-        uses: docker://oskarstark/php-cs-fixer-ga
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
         with:
-          args: --allow-risky=yes
+          php-version: 8.1
 
+      - name: Install Composer
+        run: composer install --no-interaction
+      - name: Run Laravel Pint
+        run: composer format
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4
         with:

.github/workflows/update-changelog.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: main
 

README.md

@@ -1,14 +1,21 @@
-# laravel-brevo-notifier
+<p align="center"><img src="./art/logo.svg" alt="Laravel Brevo Notifier Package Logo"></p>
 
-Easily send Brevo transactional email and sms with Laravel notifier.
+<p align="center">
+<a href="https://github.com/yieldstudio/laravel-brevo-notifier/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/yieldstudio/laravel-brevo-notifier/tests.yml?branch=main&style=flat-square" alt="Build Status"></a>
+<a href="https://github.com/yieldstudio/laravel-brevo-notifier/releases"><img src="https://img.shields.io/github/release/yieldstudio/laravel-brevo-notifier?style=flat-square" alt="Latest Stable Version"></a>
+<a href="https://packagist.org/packages/yieldstudio/laravel-brevo-notifier"><img src="https://img.shields.io/packagist/dt/yieldstudio/laravel-brevo-notifier?style=flat-square" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/yieldstudio/laravel-brevo-notifier"><img src="https://img.shields.io/packagist/l/yieldstudio/laravel-brevo-notifier" alt="License"></a>
+</p>
 
-[![Latest Version](https://img.shields.io/github/release/yieldstudio/laravel-brevo-notifier?style=flat-square)](https://github.com/yieldstudio/laravel-brevo-notifier/releases)
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/yieldstudio/laravel-brevo-notifier/tests.yml?branch=main&style=flat-square)](https://github.com/yieldstudio/laravel-brevo-notifier/actions/workflows/tests.yml)
-[![Total Downloads](https://img.shields.io/packagist/dt/yieldstudio/laravel-brevo-notifier?style=flat-square)](https://packagist.org/packages/yieldstudio/laravel-brevo-notifier)
+Easily send Brevo transactional email and sms with Laravel.
 
 ## Installation
 
-	composer require yieldstudio/laravel-brevo-notifier
+You can install the package via composer:
+
+```bash
+composer require yieldstudio/laravel-brevo-notifier
+```
 
 ## Configure
 
@@ -21,9 +28,9 @@ MAIL_FROM_NAME=
 BREVO_SMS_SENDER=
 ```
 
-Make sure that MAIL_FROM_ADDRESS is an authenticated email on Brevo.
+Make sure that `MAIL_FROM_ADDRESS` is an authenticated email on Brevo. You can verify by logging in your Brevo account here https://app.brevo.com/senders
 
-BREVO_SMS_SENDER is limited to 11 for alphanumeric characters and 15 for numeric characters.
+`BREVO_SMS_SENDER` is limited to 11 for alphanumeric characters and 15 for numeric characters.
 
 You can publish the configuration file with:
 
@@ -33,6 +40,8 @@ php artisan vendor:publish --provider="YieldStudio\LaravelBrevoNotifier\BrevoNot
 
 ## Usage
 
+Now you can use the channel in your via() method inside the notification:
+
 ### Send email
 
 ```php
@@ -61,20 +70,20 @@ class OrderConfirmation extends Notification
 }
 ```
 
-### Send sms
+### Send SMS
 
 ```php
 <?php
 
 namespace App\Notifications;
 
-use Illuminate\Notifications\Notification
+use Illuminate\Notifications\Notification;
 use YieldStudio\LaravelBrevoNotifier\BrevoSmsChannel;
 use YieldStudio\LaravelBrevoNotifier\BrevoSmsMessage;
 
 class OrderConfirmation extends Notification
 {
-    public function via()
+    public function via(): array
     {
         return [BrevoSmsChannel::class];
     }

composer.json

@@ -29,15 +29,15 @@
     ],
     "require": {
         "php": "^8.1|^8.2",
-        "illuminate/database": "^9|^10",
-        "illuminate/support": "^9|^10"
+        "illuminate/database": "^10|^11",
+        "illuminate/support": "^10|^11"
     },
     "require-dev": {
         "ciareis/bypass": "^1.0",
-        "friendsofphp/php-cs-fixer": "^3.8",
+        "laravel/pint": "^1.16",
         "orchestra/testbench": "^7.22|^8.1",
-        "pestphp/pest": "^1.21",
-        "phpunit/phpunit": "^9.1"
+        "pestphp/pest": "^2.34",
+        "phpunit/phpunit": "^10.5"
     },
     "autoload": {
         "psr-4": {
@@ -50,7 +50,7 @@
         }
     },
     "scripts": {
-        "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes",
+        "format": "vendor/bin/pint",
         "test": "vendor/bin/pest",
         "post-autoload-dump": [
             "@php ./vendor/bin/testbench package:discover --ansi"

config/brevo.php

@@ -1,10 +1,45 @@
 <?php
 
+declare(strict_types=1);
+
 return [
+    /*
+    |--------------------------------------------------------------------------
+    | API Token
+    |--------------------------------------------------------------------------
+    |
+    | Your API token from brevo.com.
+    | see: https://app.brevo.com/settings/keys/api
+    |
+    */
+
     'key' => env('BREVO_KEY'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Email Sender
+    |--------------------------------------------------------------------------
+    |
+    | Email and Name used by Brevo when sending email.
+    | This configuration is used when sending mail.
+    |
+    */
+
     'emailFrom' => [
         'email' => env('MAIL_FROM_ADDRESS'),
-        'name' => env('MAIL_FROM_NAME')
+        'name' => env('MAIL_FROM_NAME'),
     ],
-    'smsFrom' => env('BREVO_SMS_SENDER')
+
+    /*
+    |--------------------------------------------------------------------------
+    | SMS Sender
+    |--------------------------------------------------------------------------
+    |
+    | Defines the name that will be used as the "from" for all outgoing text messages
+    | This name is limited to 11 for alphanumeric characters and 15 for numeric characters.
+    |
+    */
+
+    'smsFrom' => env('BREVO_SMS_SENDER'),
+
 ];

phpunit.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
          backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
          colors="true"
          verbose="true"
          convertErrorsToExceptions="true"
@@ -11,12 +11,12 @@
          stopOnFailure="false">
     <testsuites>
         <testsuite name="Laravel Brevo Notifier Test Suite">
-            <directory>tests</directory>
+            <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
     <filter>
-        <whitelist>
-            <directory>src/</directory>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src/</directory>
         </whitelist>
     </filter>
 </phpunit>

pint.json

@@ -0,0 +1,10 @@
+{
+  "preset": "laravel",
+  "rules": {
+    "concat_space": {
+      "spacing": "one"
+    },
+    "blank_line_before_statement": true,
+    "declare_strict_types": true
+  }
+}