Merge remote-tracking branch 'origin/payload' into payload

Minishlink · Minishlink · commit 761a9d2837f2 · 2015-12-04T09:46:32.000+01:00
diff --git a/README.md b/README.md
@@ -14,36 +14,42 @@ As it is standardized, you don't have to worry about what server type it relies
 
 use Minishlink\WebPush\WebPush;
 
-// array of endpoints
-$endpoints = array(
-    'https://updates.push.services.mozilla.com/push/abc...', // Firefox 43+
-    'https://updates.push.services.mozilla.com/push/def...',
-    'https://example.com/other/endpoint/of/another/vendor/abc...',
-    'https://example.com/other/endpoint/of/another/vendor/abc...',
-);
-
-// array of payloads which are strings or null (json_encode your arrays)
-$payloads = array(
-    'hello !',
-    '{"msg":"test"}',
-    null,
-    '',
-);
-
-// array of the public keys of each users
-$userPublicKeys = array(
-    'thePublicKeysCorrespondingToFirstEndpoint',
-    'thePublicKeysCorrespondingToSecondEndpoint',
-    'thePublicKeysCorrespondingToThirdEndpoint',
-    'thePublicKeysCorrespondingToFourthEndpoint',
+// array of notifications
+$notifications = array(
+    array(
+        'endpoint' => 'https://updates.push.services.mozilla.com/push/abc...', // Firefox 43+
+        'payload' => 'hello !',
+        'userPublicKey' => 'dahaj5365sq',
+    ), array(
+        'endpoint' => 'https://android.googleapis.com/gcm/send/abcdef...', // Chrome
+        'payload' => null,
+        'userPublicKey' => null,
+    ), array(
+        'endpoint' => 'https://example.com/other/endpoint/of/another/vendor/abcdef...',
+        'payload' => '{"msg":"test"}',
+        'userPublicKey' => 'fsqdjknadsanlk',
+    ),
 );
 
 $webPush = new WebPush();
-$webPush->sendNotification($endpoints[0]); // send one notification without payload
-$webPush->sendNotifications($endpoints); // send multiple notifications without payloads
 
-$webPush->sendNotification($endpoints[0], $payloads[0], $userPublicKeys[0]); // send one notification with payload
-$webPush->sendNotifications($endpoints, $payloads, $userPublicKeys); // send multiple notifications with payloads
+// send multiple notifications with payload
+foreach ($notifications as $notification) {
+    $webPush->sendNotification(
+        $notification['endpoint'],
+        $notification['payload'], // optional (defaults null)
+        $notification['userPublicKey'] // optional (defaults null)
+    );
+}
+$webPush->flush();
+
+// send one notification and flush directly
+$webPush->sendNotification(
+    $notifications[0]['endpoint'],
+    $notifications[0]['payload'], // optional (defaults null)
+    $notifications[0]['userPublicKey'], // optional (defaults null)
+    true // optional (defaults false)
+);
 ```
 
 ### GCM servers notes (Chrome)
@@ -64,7 +70,7 @@ $apiKeys = array(
 );
 
 $webPush = new WebPush($apiKeys);
-$webPush->sendNotification($endpoint);
+$webPush->sendNotification($endpoint, null, null, true);
 ```
 
 ### Changing the browser client
@@ -96,6 +102,13 @@ $browser = $webPush->getBrowser();
 
 ## Common questions
 
+### Is there any plugin/bundle/extension for my favorite PHP framework?
+The following are available:
+
+- Symfony: [MinishlinkWebPushBundle](https://github.com/Minishlink/web-push-bundle)
+
+Feel free to add your own!
+
 ### Is the API stable?
 Not until the [Push API spec](http://www.w3.org/TR/push-api/) is finished.
 
diff --git a/src/Notification.php b/src/Notification.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the WebPush library.
+ *
+ * (c) Louis Lagrange <lagrange.louis@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Minishlink\WebPush;
+
+class Notification
+{
+    /** @var string */
+    private $endpoint;
+
+    /** @var string|null */
+    private $payload;
+
+    /** @var string|null Base64 encoded */
+    private $userPublicKey;
+
+    public function __construct($endpoint, $payload, $userPublicKey)
+    {
+        $this->endpoint = $endpoint;
+        $this->payload = $payload;
+        $this->userPublicKey = $userPublicKey;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEndpoint()
+    {
+        return $this->endpoint;
+    }
+
+    /**
+     * @return null|string
+     */
+    public function getPayload()
+    {
+        return $this->payload;
+    }
+
+    /**
+     * @return null|string
+     */
+    public function getUserPublicKey()
+    {
+        return $this->userPublicKey;
+    }
+}
diff --git a/src/WebPush.php b/src/WebPush.php
@@ -28,6 +28,14 @@ class WebPush
     /** @var array Key is push server type and value is the API key */
     protected $apiKeys;
 
+    /** @var array Array of array of Notifications by server type */
+    private $notificationsByServerType;
+
+    /** @var array Array of not standard endpoint sources */
+    private $urlByServerType = array(
+        'GCM' => 'https://android.googleapis.com/gcm/send',
+    );
+
     /**
      * WebPush constructor.
      *
@@ -48,57 +56,56 @@ public function __construct(array $apiKeys = array(), $TTL = null, $timeout = nu
     }
 
     /**
-     * Send one notification.
+     * Send a notification.
      *
      * @param string      $endpoint
-     * @param string|null $payload       If you want to send an array, json_encode it.
+     * @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)
      *
-     * @return array
-     *
+     * @return bool|array Return an array of information if $flush is set to true and the request has failed. Else return true.
      * @throws \ErrorException
      */
-    public function sendNotification($endpoint, $payload = null, $userPublicKey = null)
+    public function sendNotification($endpoint, $payload = null, $userPublicKey = null, $flush = false)
     {
-        $endpoints = array($endpoint);
-        $payloads = isset($payload) ? array($payload) : null;
-        $userPublicKeys = isset($userPublicKey) ? array($userPublicKey) : null;
+        // sort notification by server type
+        $type = $this->sortEndpoint($endpoint);
+        $this->notificationsByServerType[$type][] = new Notification($endpoint, $payload, $userPublicKey);
 
-        return $this->sendNotifications($endpoints, $payloads, $userPublicKeys);
+        if ($flush) {
+            $res = $this->flush();
+            return is_array($res) ? $res[0] : true;
+        }
+
+        return true;
     }
 
     /**
-     * Send multiple notifications.
-     *
-     * @param array      $endpoints
-     * @param array|null $payloads
-     * @param array|null $userPublicKeys
+     * Flush notifications. Triggers the requests.
      *
-     * @return array
+     * @return array|bool If there are no errors, return true.
+     * Else return an array of information for each notification sent (success, statusCode, headers).
      *
      * @throws \ErrorException
      */
-    public function sendNotifications(array $endpoints, array $payloads = null, array $userPublicKeys = null)
+    public function flush()
     {
-        // sort endpoints by server type
-        $endpointsByServerType = $this->sortEndpoints($endpoints);
-
-        // if GCM we should check for the API key
-        if (array_key_exists('GCM', $endpointsByServerType)) {
+        // if GCM is present, we should check for the API key
+        if (array_key_exists('GCM', $this->notificationsByServerType)) {
             if (empty($this->apiKeys['GCM'])) {
                 throw new \ErrorException('No GCM API Key specified.');
             }
         }
 
         // for each endpoint server type
         $responses = array();
-        foreach ($endpointsByServerType as $serverType => $endpoints) {
+        foreach ($this->notificationsByServerType as $serverType => $notifications) {
             switch ($serverType) {
                 case 'GCM':
-                    $responses += $this->sendToGCMEndpoints($endpoints);
+                    $responses += $this->sendToGCMEndpoints($notifications);
                     break;
                 case 'standard':
-                    $responses += $this->sendToStandardEndpoints($endpoints, $payloads, $userPublicKeys);
+                    $responses += $this->sendToStandardEndpoints($notifications);
                     break;
             }
         }
@@ -111,23 +118,31 @@ public function sendNotifications(array $endpoints, array $payloads = null, arra
         }
 
         /** @var Response|null $response */
+        $return = array();
+        $completeSuccess = true;
         foreach ($responses as $response) {
             if (!isset($response)) {
-                return array(
+                $return[] = array(
                     'success' => false,
                 );
+
+                $completeSuccess = false;
             } elseif (!$response->isSuccessful()) {
-                return array(
+                $return[] = array(
                     'success' => false,
                     'statusCode' => $response->getStatusCode(),
                     'headers' => $response->getHeaders(),
                 );
+
+                $completeSuccess = false;
+            } else {
+                $return[] = array(
+                    'success' => true,
+                );
             }
         }
 
-        return array(
-            'success' => true,
-        );
+        return $completeSuccess ? true : $return;
     }
 
     /**
@@ -172,23 +187,16 @@ private function encrypt($userPublicKey, $payload)
         );
     }
 
-    /**
-     * @param array      $endpoints
-     * @param array|null $payloads
-     * @param array|null $userPublicKeys
-     *
-     * @return array
-     *
-     * @throws \ErrorException
-     */
-    private function sendToStandardEndpoints(array $endpoints, array $payloads = null, array $userPublicKeys = null)
+    private function sendToStandardEndpoints(array $notifications)
     {
         $responses = array();
-        foreach ($endpoints as $i => $endpoint) {
-            $payload = $payloads[$i];
+        /** @var Notification $notification */
+        foreach ($notifications as $notification) {
+            $payload = $notification->getPayload();
+            $userPublicKey = $notification->getUserPublicKey();
 
-            if (isset($payload)) {
-                $encrypted = $this->encrypt($userPublicKeys[$i], $payload);
+            if (isset($payload) && isset($userPublicKey)) {
+                $encrypted = $this->encrypt($userPublicKey, $payload);
 
                 $headers = array(
                     'Content-Length' => strlen($encrypted['cipherText']),
@@ -211,29 +219,25 @@ private function sendToStandardEndpoints(array $endpoints, array $payloads = nul
                 $headers['TTL'] = $this->TTL;
             }
 
-            $responses[] = $this->sendRequest($endpoint, $headers, $content);
+            $responses[] = $this->sendRequest($notification->getEndpoint(), $headers, $content);
         }
 
         return $responses;
     }
 
-    /**
-     * @param array $endpoints
-     *
-     * @return array
-     */
-    private function sendToGCMEndpoints(array $endpoints)
+    private function sendToGCMEndpoints(array $notifications)
     {
         $maxBatchSubscriptionIds = 1000;
-        $url = 'https://android.googleapis.com/gcm/send';
+        $url = $this->urlByServerType['GCM'];
 
         $headers['Authorization'] = 'key='.$this->apiKeys['GCM'];
         $headers['Content-Type'] = 'application/json';
 
         $subscriptionIds = array();
-        foreach ($endpoints as $endpoint) {
+        /** @var Notification $notification */
+        foreach ($notifications as $notification) {
             // get all subscriptions ids
-            $endpointsSections = explode('/', $endpoint);
+            $endpointsSections = explode('/', $notification->getEndpoint());
             $subscriptionIds[] = $endpointsSections[count($endpointsSections) - 1];
         }
 
@@ -273,35 +277,19 @@ private function sendRequest($url, array $headers, $content)
     }
 
     /**
-     * @param array $endpoints
+     * @param string $endpoint
      *
-     * @return array
+     * @return string
      */
-    private function sortEndpoints(array $endpoints)
+    private function sortEndpoint($endpoint)
     {
-        $sortedEndpoints = array();
-
-        $serverTypesByUrl = array(
-            'GCM' => 'https://android.googleapis.com/gcm/send',
-        );
-
-        foreach ($endpoints as $endpoint) {
-            $standard = true;
-
-            foreach ($serverTypesByUrl as $type => $url) {
-                if (substr($endpoint, 0, strlen($url)) === $url) {
-                    $sortedEndpoints[$type][] = $endpoint;
-                    $standard = false;
-                    break;
-                }
-            }
-
-            if ($standard) {
-                $sortedEndpoints['standard'][] = $endpoint;
+        foreach ($this->urlByServerType as $type => $url) {
+            if (substr($endpoint, 0, strlen($url)) === $url) {
+                return $type;
             }
         }
 
-        return $sortedEndpoints;
+        return 'standard';
     }
 
     /**
diff --git a/tests/WebPushTest.php b/tests/WebPushTest.php
