Handles more errors, expands Response class

.travis.yml

@@ -0,0 +1,9 @@
+language: php
+php:
+  - "5.6"
+  - "7.0"
+  - "7.1"
+install: composer install
+script:
+  - vendor/bin/phpunit
+  - vendor/bin/phpcs --standard=PSR2 library/ tests/

README.md

@@ -1,7 +1,7 @@
 Google Cloud Messaging (GCM) PHP Server Library
 --------------------------------------------
 
-A PHP library for sending messages to devices registered through Google Cloud Messaging.
+A PHP library for sending messages to devices registered through Google Cloud Messaging. [![Build Status](https://travis-ci.org/dommccarty/GCMMessage.svg?branch=master)](https://travis-ci.org/dommccarty/GCMMessage)
 
 See:
 http://developer.android.com/guide/google/gcm/index.html
@@ -20,7 +20,7 @@ $message = new GCM\Message(
 );
 
 $message
-    ->notification(array("title" => "foo", "body" => "bar"))
+    ->setNotification(array("title" => "foo", "body" => "bar"))
     ->setCollapseKey("collapse_key")
     ->setDelayWhileIdle(true)
     ->setTtl(123)
@@ -40,7 +40,21 @@ try {
     }
 
     if ($response->getFailureCount() > 0) {
-        $invalidRegistrationIds = $GCMresponse->getInvalidRegistrationIds();
+
+        if ($response->getExistsInvalidDataKey()) {
+            //You used a reserved data key
+            $error_msg = 'Invalid data key in payload. ' . json_encode($message->getNotification());
+            throw new Exception($error_msg, Exception::INVALID_DATA_KEY);
+        }
+
+        if ($response->getExistsMismatchSenderId()) {
+            //A client sent the wrong senderId when it registered for pushes
+            $error_msg = 'Mismatch senderId. Problem clients are '
+                . json_encode($response->getMismatchSenderIdIds());
+            throw new Exception($error_msg, Exception::MISMATCH_SENDER_ID);
+        } 
+
+        $invalidRegistrationIds = $response->getInvalidRegistrationIds();
         foreach($invalidRegistrationIds as $invalidRegistrationId) {
             //Remove $invalidRegistrationId from DB
             //TODO
@@ -53,11 +67,20 @@ try {
 } catch (GCM\Exception $e) {
 
     switch ($e->getCode()) {
+
+        case GCM\Exception::UNKNOWN_ERROR:
+            if ($e->getMustRetry()) {
+                $waitSeconds = $e->getWaitSeconds();
+                //retry in that many seconds, and use exponential back-off subsequently.
+                //TODO
+                break;
+            }
         case GCM\Exception::ILLEGAL_API_KEY:
         case GCM\Exception::AUTHENTICATION_ERROR:
-        case GCM\Exception::MALFORMED_REQUEST:
-        case GCM\Exception::UNKNOWN_ERROR:
+        case GCM\Exception::MALFORMED_REQUEST:	
         case GCM\Exception::MALFORMED_RESPONSE:
+        case GCM\Exception::INVALID_DATA_KEY: //you used a forbidden key in the notification
+        case GCM\Exception::MISMATCH_SENDER_ID; //a client sent the wrong senderId when it registered for pushes
             //Deal with it
             break;
     }
@@ -89,7 +112,21 @@ try {
     }
 
     if ($response->getFailureCount() > 0) {
-        $invalidRegistrationIds = $GCMresponse->getInvalidRegistrationIds();
+
+        if ($response->getExistsInvalidDataKey()) {
+            //You used a reserved data key
+            $error_msg = 'Invalid data key in payload. ' . json_encode($message->getNotification());
+            throw new Exception($error_msg, Exception::INVALID_DATA_KEY);
+        }
+
+        if ($response->getExistsMismatchSenderId()) {
+            //A client sent the wrong senderId when it registered for pushes
+            $error_msg = 'Mismatch senderId. Problem clients are '
+                . json_encode($response->getMismatchSenderIdIds());
+            throw new Exception($error_msg, Exception::MISMATCH_SENDER_ID);
+        } 
+
+        $invalidRegistrationIds = $response->getInvalidRegistrationIds();
         foreach($invalidRegistrationIds as $invalidRegistrationId) {
             //Remove $invalidRegistrationId from DB
             //TODO
@@ -102,11 +139,20 @@ try {
 } catch (GCM\Exception $e) {
 
     switch ($e->getCode()) {
+
+        case GCM\Exception::UNKNOWN_ERROR:
+            if ($e->getMustRetry()) {
+                $waitSeconds = $e->getWaitSeconds();
+                //retry in that many seconds, and use exponential back-off subsequently.
+                //TODO
+                break;
+            }
         case GCM\Exception::ILLEGAL_API_KEY:
         case GCM\Exception::AUTHENTICATION_ERROR:
-        case GCM\Exception::MALFORMED_REQUEST:
-        case GCM\Exception::UNKNOWN_ERROR:
+        case GCM\Exception::MALFORMED_REQUEST:	
         case GCM\Exception::MALFORMED_RESPONSE:
+        case GCM\Exception::INVALID_DATA_KEY: //you used a forbidden key in the notification
+        case GCM\Exception::MISMATCH_SENDER_ID; //a client sent the wrong senderId when it registered for pushes
             //Deal with it
             break;
     }
@@ -131,8 +177,6 @@ $sender = new GCM\Sender("YOUR GOOGLE API KEY", false, "/path/to/cacert.crt");
 
 ChangeLog
 ----------------------
-* v0.3 - Content-available added (https://github.com/CodeMonkeysRu/GCMMessage/pull/11)
-* v0.2 - Notifications added
-* v0.1 - Initial release
+
 
 Licensed under MIT license.

composer.json

@@ -1,24 +1,32 @@
 {
-	"name": "codemonkeys-ru/gcm-message",
-	"type": "library",
-    	"description": "Google Cloud Messaging (GCM) PHP Server Library",
-    	"keywords": ["GCM", "push message", "android"],
-    	"authors": [
-		{
-			"name": "Vladimir Savenkov",
-			"email": "ivariable@gmail.com",
-			"homepage": "http://ivariable.ru",
-			"role": "Developer"
-		}
-    	],
-    	"license": "MIT",
-    	"require": {
-        	"php": ">=5.3.2"
-    	},
-	"minimum-stability": "dev",
-	"autoload": {
-        	"psr-0": {
-			"CodeMonkeysRu\\GCM": "library/"
-		}
-    	}
+  "name": "codemonkeys-ru/gcm-message",
+  "minimum-stability": "stable",
+  "type": "library",
+  "description": "Google Cloud Messaging (GCM) PHP Server Library",
+  "keywords": [
+    "GCM",
+    "push message",
+    "android"
+  ],
+  "authors": [
+    {
+      "name": "Vladimir Savenkov",
+      "email": "ivariable@gmail.com",
+      "homepage": "https://github.com/iVariable",
+      "role": "Maintainer"
+    }
+  ],
+  "license": "MIT",
+  "autoload": {
+    "psr-0": {
+      "CodeMonkeysRu\\GCM": "library/"
+    }
+  },
+  "require": {
+    "php": ">=5.6"
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "2.*",
+    "phpunit/phpunit": "5.7.*"
+  }
 }

library/CodeMonkeysRu/GCM/Exception.php

@@ -9,5 +9,26 @@ class Exception extends \Exception
     const MALFORMED_REQUEST = 3;
     const UNKNOWN_ERROR = 4;
     const MALFORMED_RESPONSE = 5;
-
-}
+    const INVALID_DATA_KEY = 6;
+    const MISMATCH_SENDER_ID = 7;
+
+    private $mustRetry = false;
+    private $waitSeconds = null;
+
+    public function setMustRetry($bool)
+    {
+        $this->mustRetry = $bool;
+    }
+    public function getMustRetry()
+    {
+        return $this->mustRetry;
+    }
+    public function setWaitSeconds($int)
+    {
+        $this->waitSeconds = $int;
+    }
+    public function getWaitSeconds()
+    {
+        return $this->waitSeconds;
+    }
+}

library/CodeMonkeysRu/GCM/Message.php

@@ -113,8 +113,8 @@ public function __construct($registrationIds = null, $data = null, $collapseKey
     /**
      * Set multiple fields at once.
      *
-     * @param string[] $registrationIds
-     * @param array|null $data
+     * @param string[]    $registrationIds
+     * @param array|null  $data
      * @param string|null $collapseKey
      */
     public function bulkSet($registrationIds = array(), $data = null, $collapseKey = null)
@@ -222,4 +222,4 @@ public function setContentAvailable($contentAvailable)
         $this->contentAvailable = $contentAvailable;
         return $this;
     }
-}
+}