Merge pull request #25 from ker0x/readme

📝 Add note about changed in v3.0

Author: ker0x

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: php-setup
         uses: shivammathur/setup-php@v2

README.md

@@ -9,12 +9,11 @@
 
 A PHP library to send push notification with [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)
 
-## Warning
-
-Version `3.x` of this library is a full rewrite using [PSR-18 HTTP Client](https://www.php-fig.org/psr/psr-18/) interface, 
-which means that **no** HTTP Client, like [Guzzle](https://github.com/guzzle/guzzle) or [httplug](https://github.com/php-http/httplug), 
-are provided within. If you already have one in your project, the package will **automatically discover it** and use it.
-Otherwise You will need to require one separately.
+> [!NOTE]
+> Version `3.x` of this library is a full rewrite using [PSR-18 HTTP Client](https://www.php-fig.org/psr/psr-18/) interface, 
+> which means that **no** HTTP Client, like [Guzzle](https://github.com/guzzle/guzzle) or [httplug](https://github.com/php-http/httplug), 
+> are provided within. If you already have one in your project, the package will **automatically discover it** and use it.
+> Otherwise You will need to require one separately.
 
 ## Installation
 

composer.json

@@ -25,16 +25,16 @@
     "psr/http-client": "^1.0",
     "psr/http-client-implementation": "*",
     "psr/http-factory-implementation": "*",
-    "symfony/property-access": "^6.2",
-    "symfony/serializer": "^6.2"
+    "symfony/property-access": "^6.4 || ^7.0",
+    "symfony/serializer": "^6.4 || ^7.0"
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.16",
     "nyholm/psr7": "^1.8",
     "phpstan/phpstan": "^1.10",
     "phpunit/phpunit": "^10.1",
     "rector/rector": "^0.16.0",
-    "symfony/http-client": "^6.2"
+    "symfony/http-client": "^7.0"
   },
   "config": {
     "optimize-autoloader": true,

src/Api/Send.php

@@ -4,15 +4,14 @@
 
 namespace Kerox\Fcm\Api;
 
-use Doctrine\Common\Annotations\AnnotationReader;
 use Fig\Http\Message\RequestMethodInterface;
 use Http\Discovery\Psr18Client;
 use Kerox\Fcm\Fcm;
 use Kerox\Fcm\Model\Message;
 use Psr\Http\Message\ResponseInterface;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
-use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
+use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
 use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
@@ -30,7 +29,7 @@ public function __construct(
         private string $projectId,
         private Psr18Client $client
     ) {
-        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+        $classMetadataFactory = new ClassMetadataFactory(new AttributeLoader());
         $metadataAwareNameConverter = new MetadataAwareNameConverter($classMetadataFactory, new CamelCaseToSnakeCaseNameConverter());
 
         $this->serializer = new Serializer(

src/Fcm.php

@@ -14,9 +14,6 @@
 
     private Psr18Client $client;
 
-    /**
-     * Fcm constructor.
-     */
     public function __construct(
         private string $oauthToken,
         private string $projectId,

src/Model/Config/ApnsConfig.php

@@ -12,23 +12,24 @@
  */
 final readonly class ApnsConfig
 {
-    public object $payload;
+    public ?object $payload;
 
     /**
      * @param array<string, string> $headers
      */
     public function __construct(
-        ?ApnsNotification $notification = null,
+        ApnsNotification $notification = null,
         public array $headers = [],
         public ?ApnsFcmOptions $fcmOptions = null,
     ) {
-        if (null !== $notification) {
-            $this->payload = new class($notification) {
+        $this->payload = null !== $notification
+            ? new class($notification) {
                 public function __construct(
                     public ApnsNotification $aps
                 ) {
                 }
-            };
-        }
+            }
+            : null
+        ;
     }
 }

src/Model/Message.php

@@ -16,12 +16,12 @@
 /**
  * @see https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#resource:-message
  */
-final readonly class Message
+final class Message
 {
     public Notification $notification;
-    public ?string $token;
-    public ?string $topic;
-    public ?string $condition;
+    public ?string $token = null;
+    public ?string $topic = null;
+    public ?string $condition = null;
 
     /**
      * @param array<string, string> $data

tests/Model/MessageTest.php

@@ -4,7 +4,6 @@
 
 namespace Kerox\Fcm\Tests\Model;
 
-use Doctrine\Common\Annotations\AnnotationReader;
 use Kerox\Fcm\Enum\AndroidMessagePriority;
 use Kerox\Fcm\Enum\Direction;
 use Kerox\Fcm\Enum\NotificationPriority;
@@ -32,7 +31,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
-use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
+use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
 use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
@@ -46,7 +45,7 @@ final class MessageTest extends TestCase
 
     protected function setUp(): void
     {
-        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+        $classMetadataFactory = new ClassMetadataFactory(new AttributeLoader());
         $metadataAwareNameConverter = new MetadataAwareNameConverter($classMetadataFactory, new CamelCaseToSnakeCaseNameConverter());
 
         $this->serializer = new Serializer(