Wrong typing of the Grant Token endpoint (#108)

seba-aln · pubnub-release-bot · web-flow · commit f7cdc6347cff · 2024-10-22T13:27:41.000+02:00
* Wrong typing of the Grant Token endpoint

* linter fixes

* fix errors and bump pubnub.yml

* Add organization prefix to gh actions

* fix typo in pubnub.yaml and bump php in test matrix

* PubNub SDK 7.0.2 release.

---------

Co-authored-by: PubNub Release Bot &lt;120067856+pubnub-release-bot@users.noreply.github.com&gt;
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -19,7 +19,7 @@ jobs:
       max-parallel: 1
       fail-fast: true
       matrix:
-        php: [8.0, 8.1, 8.2]
+        php: [8.1, 8.2, 8.3]
     env:
       PUBLISH_KEY: ${{ secrets.SDK_PUB_KEY }}
       SUBSCRIBE_KEY: ${{ secrets.SDK_SUB_KEY }}
diff --git a/.pubnub.yml b/.pubnub.yml
@@ -1,8 +1,15 @@
 name: php
-version: 7.0.1
+version: 7.0.2
 schema: 1
 scm: github.com/pubnub/php
 changelog:
+  - date: 2024-10-22
+    version: 7.0.2
+    changes:
+      - type: bug
+        text: "Fixed wrong type annotation for grant token response value."
+      - type: improvement
+        text: "Updated compatibility list."
   - date: 2024-07-10
     version: 7.0.1
     changes:
@@ -319,25 +326,21 @@ sdks:
               supported-operating-systems:
                 macOS:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
                     - Mac OS X 10.8
                   maximum-os-version:
-                    - macOS 11.2.3
+                    - macOS 15.0.1
                   target-architecture:
                     - arm64
                     - x86-64
                 Windows:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
                     - Windows 7 Professional
                     - Windows 7 Enterprise
@@ -350,15 +353,13 @@ sdks:
                     - x86-64
                 Linux:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
-                    - Ubuntu 16.04 LTS
+                    - Ubuntu 20.04 LTS
                   maximum-os-version:
-                    - Ubuntu 18.04 LTS
+                    - Ubuntu 24.04.1 LTS
                   target-architecture:
                     - x86
                     - x86-64
@@ -387,25 +388,21 @@ sdks:
               supported-operating-systems:
                 macOS:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
                     - Mac OS X 10.8
                   maximum-os-version:
-                    - macOS 11.2.3
+                    - macOS 15.0.1
                   target-architecture:
                     - arm64
                     - x86-64
                 Windows:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
                     - Windows 7 Professional
                     - Windows 7 Enterprise
@@ -418,22 +415,20 @@ sdks:
                     - x86-64
                 Linux:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
-                    - Ubuntu 16.04 LTS
+                    - Ubuntu 20.04 LTS
                   maximum-os-version:
-                    - Ubuntu 18.04 LTS
+                    - Ubuntu 24.04.1 LTS
                   target-architecture:
                     - x86
                     - x86-64
           - distribution-type: library
             distribution-repository: GitHub release
-            package-name: php-7.0.1.zip
-            location: https://github.com/pubnub/php/releases/tag/7.0.1
+            package-name: php-7.0.2.zip
+            location: https://github.com/pubnub/php/releases/tag/7.0.2
             requires:
               - name: rmccue/requests
                 min-version: 1.0.0
@@ -455,25 +450,21 @@ sdks:
               supported-operating-systems:
                 macOS:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
                     - Mac OS X 10.8
                   maximum-os-version:
-                    - macOS 11.2.3
+                    - macOS 15.0.1
                   target-architecture:
                     - arm64
                     - x86-64
                 Windows:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
                     - Windows 7 Professional
                     - Windows 7 Enterprise
@@ -486,15 +477,13 @@ sdks:
                     - x86-64
                 Linux:
                   runtime-version:
-                    - PHP 5.6
-                    - PHP 7.0
-                    - PHP 7.1
-                    - PHP 7.2
-                    - PHP 7.3
+                    - PHP 8.1
+                    - PHP 8.2
+                    - PHP 8.3
                   minimum-os-version:
-                    - Ubuntu 16.04 LTS
+                    - Ubuntu 20.04 LTS
                   maximum-os-version:
-                    - Ubuntu 18.04 LTS
+                    - Ubuntu 24.04.1 LTS
                   target-architecture:
                     - x86
                     - x86-64
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,12 @@
+## 7.0.2
+October 22 2024
+
+#### Fixed
+- Fixed wrong type annotation for grant token response value.
+
+#### Modified
+- Updated compatibility list.
+
 ## 7.0.1
 July 10 2024
 
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ You will need the publish and subscribe keys to authenticate your app. Get your
          {
              "require": {
                  <!-- include the latest version from the badge at the top -->
-                 "pubnub/pubnub": "7.0.1"
+                 "pubnub/pubnub": "7.0.2"
              }
          }
          ```
diff --git a/composer.json b/composer.json
@@ -5,7 +5,7 @@
   "keywords": ["api", "real-time", "realtime", "real time", "ajax", "push"],
   "homepage": "http://www.pubnub.com/",
   "license": "proprietary",
-  "version": "7.0.1",
+  "version": "7.0.2",
   "authors": [
     {
       "name": "PubNub",
diff --git a/examples/GrantToken.php b/examples/GrantToken.php
@@ -2,35 +2,37 @@
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
-use PubNub\Models\Access\Permissions;
 use PubNub\Models\Consumer\AccessManager\PNAccessManagerTokenResult;
 
-
 $pnconfig = new \PubNub\PNConfiguration();
-$pnconfig->setPublishKey('my-publish-key');
-$pnconfig->setSubscribeKey('my-subscribe-key');
-$pnconfig->setSecretKey('my-secret-key');
+$pnconfig->setPublishKey(getenv("PUBLISH_PAM_KEY"));
+$pnconfig->setSubscribeKey(getenv("SUBSCRIBE_PAM_KEY"));
+$pnconfig->setSecretKey(getenv("SECRET_PAM_KEY"));
+$pnconfig->setUuid('example-uuid');
 
 $pubnub = new \PubNub\PubNub($pnconfig);
 
 try {
     $token = $pubnub->grantToken()
         ->ttl(30)
-        ->authorizedUuid('my-uuid')
+        ->authorizedUuid('example-uuid')
         ->addChannelResources([
             'my-channel' => ['read' => true]
         ])
         ->sync();
 
-        /** @var PNAccessManagerTokenResult */
-        $parsedToken = $pubnub->parseToken($token);
-        $parsedToken->getTtl();
-        $parsedToken->getChannelResource('my-channel')
-            ->hasRead();
+    print("Token granted: $token\n");
+
+    /** @var PNAccessManagerTokenResult */
+    $parsedToken = $pubnub->parseToken($token);
+
+    $tokensTTL = $parsedToken->getTtl();
+    $tokensMyChannelRead = $parsedToken->getChannelResource('my-channel')->hasRead();
+    $tokensMyChannelWrite = $parsedToken->getChannelResource('my-channel')->hasWrite();
+
+    print("Token TTL: $tokensTTL\n");
+    print("Token My Channel Read: " . (int)$tokensMyChannelRead . "\n");
+    print("Token My Channel Write: " . (int)$tokensMyChannelWrite . "\n");
 } catch (\PubNub\Exceptions\PubNubServerException $e) {
     var_dump($e->getBody());
 }
-
-var_dump(
-    $pubnub->parseToken($token)->toArray()
-); die;
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -460,11 +460,6 @@ parameters:
 			count: 1
 			path: src/PubNub/Endpoints/Access/GrantToken.php
 
-		-
-			message: "#^PHPDoc tag @return has invalid value \\(\\: PNAccessManagerGrantResult\\)\\: Unexpected token \"\\:\", expected type at offset 47$#"
-			count: 1
-			path: src/PubNub/Endpoints/Access/GrantToken.php
-
 		-
 			message: "#^Property PubNub\\\\Endpoints\\\\Access\\\\GrantToken\\:\\:\\$channels has no type specified\\.$#"
 			count: 1
diff --git a/src/PubNub/Endpoints/Access/GrantToken.php b/src/PubNub/Endpoints/Access/GrantToken.php
@@ -4,7 +4,6 @@
 
 use PubNub\Endpoints\Endpoint;
 use PubNub\Exceptions\PubNubValidationException;
-use PubNub\Models\Consumer\AccessManager\PNAccessManagerGrantResult;
 use PubNub\PubNubUtil;
 use PubNub\Enums\PNHttpMethod;
 use PubNub\Enums\PNOperationType;
@@ -237,18 +236,18 @@ public function buildPath()
     }
 
     /**
-     * @return PNAccessManagerGrantResult
+     * @return string
      */
-    public function sync(): PNAccessManagerGrantResult
+    public function sync(): string
     {
         return parent::sync();
     }
 
     /**
      * @param string $token
-     * @return : PNAccessManagerGrantResult
+     * @return string
      */
-    public function createResponse($response): PNAccessManagerGrantResult
+    public function createResponse($response): string
     {
         return $response['data']['token'];
     }
diff --git a/src/PubNub/PubNub.php b/src/PubNub/PubNub.php
@@ -57,7 +57,7 @@
 
 class PubNub implements LoggerAwareInterface
 {
-    protected const SDK_VERSION = "7.0.1";
+    protected const SDK_VERSION = "7.0.2";
     protected const SDK_NAME = "PubNub-PHP";
 
     public static $MAX_SEQUENCE = 65535;

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ You will need the publish and subscribe keys to authenticate your app. Get your`
`41`	`41`	`{`
`42`	`42`	`"require": {`
`43`	`43`	`<!-- include the latest version from the badge at the top -->`
`44`		`- "pubnub/pubnub": "7.0.1"`
	`44`	`+ "pubnub/pubnub": "7.0.2"`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`	```
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`"keywords": ["api", "real-time", "realtime", "real time", "ajax", "push"],`
`6`	`6`	`"homepage": "http://www.pubnub.com/",`
`7`	`7`	`"license": "proprietary",`
`8`		`- "version": "7.0.1",`
	`8`	`+ "version": "7.0.2",`
`9`	`9`	`"authors": [`
`10`	`10`	`{`
`11`	`11`	`"name": "PubNub",`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`use PubNub\Endpoints\Endpoint;`
`6`	`6`	`use PubNub\Exceptions\PubNubValidationException;`
`7`		`-use PubNub\Models\Consumer\AccessManager\PNAccessManagerGrantResult;`
`8`	`7`	`use PubNub\PubNubUtil;`
`9`	`8`	`use PubNub\Enums\PNHttpMethod;`
`10`	`9`	`use PubNub\Enums\PNOperationType;`
`@@ -237,18 +236,18 @@ public function buildPath()`
`237`	`236`	`}`
`238`	`237`
`239`	`238`	`/**`
`240`		`- * @return PNAccessManagerGrantResult`
	`239`	`+ * @return string`
`241`	`240`	`*/`
`242`		`- public function sync(): PNAccessManagerGrantResult`
	`241`	`+ public function sync(): string`
`243`	`242`	`{`
`244`	`243`	`return parent::sync();`
`245`	`244`	`}`
`246`	`245`
`247`	`246`	`/**`
`248`	`247`	`* @param string $token`
`249`		`- * @return : PNAccessManagerGrantResult`
	`248`	`+ * @return string`
`250`	`249`	`*/`
`251`		`- public function createResponse($response): PNAccessManagerGrantResult`
	`250`	`+ public function createResponse($response): string`
`252`	`251`	`{`
`253`	`252`	`return $response['data']['token'];`
`254`	`253`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@`
`57`	`57`
`58`	`58`	`class PubNub implements LoggerAwareInterface`
`59`	`59`	`{`
`60`		`- protected const SDK_VERSION = "7.0.1";`
	`60`	`+ protected const SDK_VERSION = "7.0.2";`
`61`	`61`	`protected const SDK_NAME = "PubNub-PHP";`
`62`	`62`
`63`	`63`	`public static $MAX_SEQUENCE = 65535;`