Merge pull request #153 from imdhemy/feat/get-notification-payload

[1.x] Get raw notification data

Author: imdhemy

composer.lock

@@ -6,28 +6,45 @@
 
 /**
  * Interface ServerNotificationContract
+ *
  * @package Imdhemy\Purchases\Events\Contracts
  */
 interface ServerNotificationContract
 {
     /**
+     * Gets the notification type
+     *
      * @return string
      */
     public function getType(): string;
 
     /**
+     * Gets the subscription associated with the notification
+     *
      * @param Client|null $client
+     *
      * @return SubscriptionContract
      */
     public function getSubscription(?Client $client = null): SubscriptionContract;
 
     /**
+     * Returns true if the notification is a test notification
+     *
      * @return bool
      */
     public function isTest(): bool;
 
     /**
+     * Gets the application bundle
+     *
      * @return string
      */
     public function getBundle(): string;
+
+    /**
+     * Gets the notification payload
+     *
+     * @return array
+     */
+    public function getPayload(): array;
 }

src/Contracts/ServerNotificationContract.php

@@ -8,10 +8,15 @@
 
 /**
  * Interface SubscriptionContract
+ *
  * @package Imdhemy\Purchases\Events\Contracts
  */
 interface SubscriptionContract
 {
+    // List of providers
+    public const PROVIDER_APP_STORE = 'app_store';
+    public const PROVIDER_GOOGLE_PLAY = 'google_play';
+
     /**
      * @return Time
      */

src/Contracts/SubscriptionContract.php

@@ -90,6 +90,16 @@ public function getBundle(): string
         return (string)$this->notification->getBid();
     }
 
+    /**
+     * Gets the notification payload
+     *
+     * @return array
+     */
+    public function getPayload(): array
+    {
+        return $this->notification->toArray();
+    }
+
     /**
      * @return string|null
      */

src/ServerNotifications/AppStoreServerNotification.php

@@ -25,6 +25,13 @@ private function __construct(V2DecodedPayload $payload)
         $this->payload = $payload;
     }
 
+    /**
+     * Static constructor
+     *
+     * @param V2DecodedPayload $decodedPayload
+     *
+     * @return static
+     */
     public static function fromDecodedPayload(V2DecodedPayload $decodedPayload): self
     {
         return new self($decodedPayload);
@@ -63,4 +70,14 @@ public function getBundle(): string
     {
         return $this->payload->getAppMetadata()->bundleId();
     }
+
+    /**
+     * Gets the notification payload
+     *
+     * @return array
+     */
+    public function getPayload(): array
+    {
+        return $this->payload->toArray();
+    }
 }

src/ServerNotifications/AppStoreV2ServerNotification.php

@@ -11,6 +11,7 @@
 
 /**
  * Class GoogleServerNotification
+ *
  * @package Imdhemy\Purchases\ServerNotifications
  */
 class GoogleServerNotification implements ServerNotificationContract
@@ -20,10 +21,11 @@ class GoogleServerNotification implements ServerNotificationContract
     /**
      * @var DeveloperNotification
      */
-    private $notification;
+    private DeveloperNotification $notification;
 
     /**
      * GoogleServerNotification constructor.
+     *
      * @param DeveloperNotification $notification
      */
     public function __construct(DeveloperNotification $notification)
@@ -45,6 +47,7 @@ public function getType(): string
 
     /**
      * @param Client|null $client
+     *
      * @return SubscriptionContract
      * @throws GuzzleException
      */
@@ -68,4 +71,14 @@ public function getBundle(): string
     {
         return $this->notification->getPackageName();
     }
+
+    /**
+     * Gets the notification payload
+     *
+     * @return array
+     */
+    public function getPayload(): array
+    {
+        return $this->notification->toArray();
+    }
 }

src/ServerNotifications/GoogleServerNotification.php

@@ -58,7 +58,7 @@ public function getItemId(): string
      */
     public function getProvider(): string
     {
-        return 'app_store';
+        return SubscriptionContract::PROVIDER_APP_STORE;
     }
 
     /**

src/Subscriptions/AppleSubscription.php

@@ -1,46 +1,44 @@
 <?php
 
-namespace Tests\ServerNotifications;
+namespace Tests\Unit\ServerNotifications;
 
 use Imdhemy\AppStore\ServerNotifications\ServerNotification;
-use Imdhemy\Purchases\Contracts\ServerNotificationContract;
 use Imdhemy\Purchases\Contracts\SubscriptionContract;
 use Imdhemy\Purchases\ServerNotifications\AppStoreServerNotification;
 use Imdhemy\Purchases\ValueObjects\Time;
+use JsonException;
 use Tests\TestCase;
 
 class AppStoreServerNotificationTest extends TestCase
 {
     /**
      * @var AppStoreServerNotification
      */
-    private $appStoreServerNotification;
+    private AppStoreServerNotification $appStoreServerNotification;
+
+    /**
+     * @var array
+     */
+    private array $serverNotificationBody;
 
     /**
      * @inheritDoc
+     * @throws JsonException
      */
     protected function setUp(): void
     {
         parent::setUp();
         $path = $this->testAssetPath('appstore-server-notification.json');
-        $serverNotificationBody = json_decode(file_get_contents($path), true);
+        $this->serverNotificationBody = json_decode(file_get_contents($path), true, 512, JSON_THROW_ON_ERROR);
 
-        $serverNotification = ServerNotification::fromArray($serverNotificationBody);
+        $serverNotification = ServerNotification::fromArray($this->serverNotificationBody);
         $this->appStoreServerNotification = new AppStoreServerNotification($serverNotification);
     }
 
     /**
      * @test
      */
-    public function test_constructor()
-    {
-        $this->assertInstanceOf(ServerNotificationContract::class, $this->appStoreServerNotification);
-    }
-
-    /**
-     * @test
-     */
-    public function test_get_notification_type()
+    public function get_notification_type(): void
     {
         $this->assertEquals(
             ServerNotification::DID_CHANGE_RENEWAL_STATUS,
@@ -51,15 +49,17 @@ public function test_get_notification_type()
     /**
      * @test
      */
-    public function test_get_subscription()
+    public function get_subscription(): void
     {
-        $this->assertInstanceOf(SubscriptionContract::class, $this->appStoreServerNotification->getSubscription());
+        $subscription = $this->appStoreServerNotification->getSubscription();
+
+        $this->assertEquals(SubscriptionContract::PROVIDER_APP_STORE, $subscription->getProvider());
     }
 
     /**
      * @test
      */
-    public function test_get_change_renewal_status_data()
+    public function get_change_renewal_status_data(): void
     {
         $isAutoRenewal = $this->appStoreServerNotification->isAutoRenewal();
         $changeDate = $this->appStoreServerNotification->getAutoRenewStatusChangeDate();
@@ -71,9 +71,23 @@ public function test_get_change_renewal_status_data()
     /**
      * @test
      */
-    public function test_get_bundle()
+    public function get_bundle(): void
     {
-        $this->assertNotNull($this->appStoreServerNotification->getBundle());
+        $this->assertEquals(
+            'com.twigano.fashion',
+            $this->appStoreServerNotification->getBundle()
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function get_payload(): void
+    {
+        $this->assertEquals(
+            $this->serverNotificationBody,
+            $this->appStoreServerNotification->getPayload()
+        );
     }
 
     /**

tests/ServerNotifications/AppStoreServerNotificationTest.php renamed to tests/Unit/ServerNotifications/AppStoreServerNotificationTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Tests\Unit\ServerNotifications;
+
+use Imdhemy\AppStore\ServerNotifications\V2DecodedPayload;
+use Imdhemy\Purchases\ServerNotifications\AppStoreV2ServerNotification;
+use Tests\TestCase;
+
+class AppStoreV2ServerNotificationTest extends TestCase
+{
+    private V2DecodedPayload $payload;
+
+    private AppStoreV2ServerNotification $sut;
+
+    /**
+     * @inheritDoc
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $claims = [
+            'notificationType' => V2DecodedPayload::TYPE_TEST,
+            'data' => [
+                'bundleId' => 'com.example.app',
+            ],
+        ];
+
+        $this->payload = V2DecodedPayload::fromArray($claims);
+
+        $this->sut = AppStoreV2ServerNotification::fromDecodedPayload($this->payload);
+    }
+
+    /**
+     * @test
+     */
+    public function get_type(): void
+    {
+        $this->assertEquals(V2DecodedPayload::TYPE_TEST, $this->sut->getType());
+    }
+
+    /**
+     * @test
+     */
+    public function get_subscription(): void
+    {
+        $this->assertSame(
+            $this->payload,
+            $this->sut->getSubscription()->getProviderRepresentation()
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function is_test(): void
+    {
+        $this->assertTrue($this->sut->isTest());
+    }
+
+    /**
+     * @test
+     */
+    public function get_bundle(): void
+    {
+        $this->assertEquals('com.example.app', $this->sut->getBundle());
+    }
+
+    /**
+     * @test
+     */
+    public function get_payload(): void
+    {
+        $this->assertSame($this->payload->toArray(), $this->sut->getPayload());
+    }
+}