change API to take into account user auth token

Author: Minishlink

phpunit.dist.xml

@@ -18,6 +18,7 @@
         <env name="STANDARD_ENDPOINT" value="" />
         <env name="GCM_ENDPOINT" value="" />
         <env name="USER_PUBLIC_KEY" value="" />
+        <env name="USER_AUTH_TOKEN" value="" />
         <env name="GCM_API_KEY" value="" />
     </php>
 </phpunit>

src/Notification.php

@@ -16,11 +16,21 @@ class Notification
     /** @var string */
     private $endpoint;
 
-    public function __construct($endpoint, $payload, $userPublicKey)
+    /** @var string */
+    private $payload;
+
+    /** @var string */
+    private $userPublicKey;
+
+    /** @var string */
+    private $userAuthToken;
+
+    public function __construct($endpoint, $payload, $userPublicKey, $userAuthToken)
     {
         $this->endpoint = $endpoint;
         $this->payload = $payload;
         $this->userPublicKey = $userPublicKey;
+        $this->userAuthToken = $userAuthToken;
     }
 
     /**
@@ -46,4 +56,12 @@ public function getUserPublicKey()
     {
         return $this->userPublicKey;
     }
+
+    /**
+     * @return null|string
+     */
+    public function getUserAuthToken()
+    {
+        return $this->userAuthToken;
+    }
 }

src/WebPush.php

@@ -66,20 +66,25 @@ public function __construct(array $apiKeys = array(), $TTL = 2419200, $timeout =
     /**
      * Send a notification.
      *
-     * @param string      $endpoint
+     * @param string $endpoint
      * @param string|null $payload If you want to send an array, json_encode it.
      * @param string|null $userPublicKey
-     * @param bool        $flush If you want to flush directly (usually when you send only one notification)
+     * @param string|null $userAuthToken
+     * @param bool $flush If you want to flush directly (usually when you send only one notification)
      *
-     * @return bool|array Return an array of information if $flush is set to true and the queued requests has failed.
+     * @return array|bool Return an array of information if $flush is set to true and the queued requests has failed.
      *                    Else return true.
      * @throws \ErrorException
      */
-    public function sendNotification($endpoint, $payload = null, $userPublicKey = null, $flush = false)
+    public function sendNotification($endpoint, $payload = null, $userPublicKey = null, $userAuthToken = null, $flush = false)
     {
+        if (isset($userAuthToken) && is_bool($userAuthToken)) {
+            throw new \ErrorException('The API has changed: sendNotification now takes the optional user auth token as parameter.');
+        }
+
         // sort notification by server type
         $type = $this->sortEndpoint($endpoint);
-        $this->notificationsByServerType[$type][] = new Notification($endpoint, $payload, $userPublicKey);
+        $this->notificationsByServerType[$type][] = new Notification($endpoint, $payload, $userPublicKey, $userAuthToken);
 
         if ($flush) {
             $res = $this->flush();
@@ -182,7 +187,7 @@ private function sendToStandardEndpoints(array $notifications)
             $userPublicKey = $notification->getUserPublicKey();
 
             if (isset($payload) && isset($userPublicKey) && ($this->payloadEncryptionSupport || $this->nativePayloadEncryptionSupport)) {
-                $encrypted = Encryption::encrypt($payload, $userPublicKey, null, $this->nativePayloadEncryptionSupport);
+                $encrypted = Encryption::encrypt($payload, $userPublicKey, $notification->getUserAuthToken(), $this->nativePayloadEncryptionSupport);
 
                 $headers = array(
                     'Content-Length' => strlen($encrypted['cipherText']),

tests/WebPushTest.php

@@ -15,6 +15,7 @@ class WebPushTest extends PHPUnit_Framework_TestCase
 {
     private $endpoints;
     private $keys;
+    private $tokens;
 
     /** @var WebPush WebPush with correct api keys */
     private $webPush;
@@ -31,12 +32,16 @@ public function setUp()
             'GCM' => getenv('GCM_API_KEY'),
         );
 
+        $this->tokens = array(
+            'standard' => getenv('USER_AUTH_TOKEN'),
+        );
+
         $this->webPush = new WebPush($this->keys);
     }
 
     public function testSendNotification()
     {
-        $res = $this->webPush->sendNotification($this->endpoints['standard'], null, null, true);
+        $res = $this->webPush->sendNotification($this->endpoints['standard'], null, null, null, true);
 
         $this->assertEquals($res, true);
     }
@@ -47,12 +52,37 @@ public function testSendNotificationWithPayload()
             $this->endpoints['standard'],
             'test',
             $this->keys['standard'],
+            $this->tokens['standard'],
             true
         );
 
         $this->assertTrue($res);
     }
 
+    public function testSendNotificationWithPayloadWithoutAuthToken()
+    {
+        $res = $this->webPush->sendNotification(
+            $this->endpoints['standard'],
+            'test',
+            $this->keys['standard'],
+            null,
+            true
+        );
+
+        $this->assertTrue($res);
+    }
+
+    public function testSendNotificationWithOldAPI()
+    {
+        $this->setExpectedException('ErrorException', 'The API has changed: sendNotification now takes the optional user auth token as parameter.');
+        $this->webPush->sendNotification(
+            $this->endpoints['standard'],
+            'test',
+            $this->keys['standard'],
+            true
+        );
+    }
+
     public function testSendNotifications()
     {
         foreach($this->endpoints as $endpoint) {
@@ -81,14 +111,14 @@ public function testSendGCMNotificationWithoutGCMApiKey()
         $webPush = new WebPush();
 
         $this->setExpectedException('ErrorException', 'No GCM API Key specified.');
-        $webPush->sendNotification($this->endpoints['GCM'], null, null, true);
+        $webPush->sendNotification($this->endpoints['GCM'], null, null, null, true);
     }
 
     public function testSendGCMNotificationWithWrongGCMApiKey()
     {
         $webPush = new WebPush(array('GCM' => 'bar'));
 
-        $res = $webPush->sendNotification($this->endpoints['GCM'], null, null, true);
+        $res = $webPush->sendNotification($this->endpoints['GCM'], null, null, null, true);
 
         $this->assertTrue(is_array($res)); // there has been an error
         $this->assertArrayHasKey('success', $res);