Merging develop to master in preparation for 2.1.0 release.

.travis.yml

@@ -1,17 +1,22 @@
+sudo: false
+
 language: php
 
-php:
-  - 5.5
-  - 5.6
-  - 7.0
-  - 7.1
-  - hhvm
+matrix:
+  include:
+    - php: 5.6
+    - php: 7.0
+    - php: 7.1
+      env:
+        - CS_CHECK=true
+    - php: 7.2
 
 before_install:
- - composer install
+  - composer install --no-interaction
 
 script:
- - ./vendor/bin/phpunit
+  - ./vendor/bin/phpunit
+  - if [[ $CS_CHECK == 'true' ]]; then ./vendor/bin/phpcs ; fi
 
 notifications:
-  irc: "irc.freenode.org#zftalk.2"
+  email: false

CHANGELOG.md

@@ -2,10 +2,16 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 2.0.1 - TBD
+## 2.1.0 - 2018-05-08
 
 ### Added
 
+- [#35](https://github.com/zendframework/ZendService_Google_Gcm/pull/35) adds support for PHP 7.1 and 7.2.
+
+- [#13](https://github.com/zendframework/ZendService_Google_Gcm/pull/13) adds constants mapping to common GCM error codes as `ZendService\Gcm\Response::ERROR_*`.
+
+### Changed
+
 - Nothing.
 
 ### Deprecated
@@ -14,11 +20,14 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Removed
 
-- Nothing.
+- [#35](https://github.com/zendframework/ZendService_Google_Gcm/pull/35) removes support for PHP 5.5.
+
+- [#35](https://github.com/zendframework/ZendService_Google_Gcm/pull/35) removes support for HHVM.
 
 ### Fixed
 
-- Nothing.
+- [#18](https://github.com/zendframework/ZendService_Google_Gcm/pull/18) adds a `Content-Length` header with the message length prior to sending
+  messages to GCM; this fixes 411 errors previously observed.
 
 ## 2.0.0 - 2017-01-17
 

LICENSE.txt → LICENSE.md

@@ -1,19 +1,19 @@
-Copyright (c) 2005-2014, Zend Technologies USA, Inc.
+Copyright (c) 2005-2018, Zend Technologies USA, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
 
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
+- Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
 
-    * Neither the name of Zend Technologies USA, Inc. nor the names of its
-      contributors may be used to endorse or promote products derived from this
-      software without specific prior written permission.
+- Neither the name of Zend Technologies USA, Inc. nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

README.md

@@ -3,18 +3,18 @@ ZendService\Google\Gcm [![Build Status](https://api.travis-ci.org/zendframework/
 
 Provides support for Google push notifications.
 
-## Requirements ##
+## Requirements
 
-* PHP >= 5.3.3
+* PHP >= 5.6
 
-## Getting Started ##
+## Getting Started
 
 Install this library using [Composer](http://getcomposer.org/):
 
 ```bash
 $ composer require zendframework/zendservice-google-gcm
 ```
 
-## Documentation ##
+## Documentation
 
 The documentation can be found at: http://framework.zend.com/manual/current/en/modules/zendservice.google.gcm.html

composer.json

@@ -1,32 +1,48 @@
 {
     "name": "zendframework/zendservice-google-gcm",
     "description": "OOP wrapper for Google Cloud Messaging",
-    "type": "library",
+    "license": "BSD-3-Clause",
     "keywords": [
-        "zf2",
+        "zf",
+        "zendframework",
         "gcm",
         "push",
         "notification",
         "google"
     ],
-    "homepage": "https://github.com/zendframework/zendservice-google-gcm",
-    "license": "BSD-3-Clause",
+    "support": {
+        "issues": "https://github.com/zendframework/ZendService_Google_Gcm/issues",
+        "source": "https://github.com/zendframework/ZendService_Google_Gcm",
+        "rss": "https://github.com/zendframework/ZendService_Google_Gcm/releases.atom",
+        "chat": "https://zendframework-slack.herokuapp.com",
+        "forum": "https://discourse.zendframework.com/c/questions/components"
+    },
+    "require": {
+        "php": "^5.6 || ^7.0",
+        "zendframework/zend-http": "^2.0",
+        "zendframework/zend-json": "^2.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.7.27 || ^6.5.8 || ^7.1.5",
+        "zendframework/zend-coding-standard": "~1.0.0"
+    },
     "autoload": {
         "psr-4": {
-            "ZendService\\Google\\": "library/"
+            "ZendService\\Google\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "ZendServiceTest\\Google\\": "tests/"
+            "ZendServiceTest\\Google\\": "test/"
         }
     },
-    "require": {
-        "php": "^5.5 || ^7.0",
-        "zendframework/zend-http": "^2.0",
-        "zendframework/zend-json": "^2.0"
+    "config": {
+        "sort-packages": true
     },
-    "require-dev": {
-        "phpunit/PHPUnit": "^4.8"
+    "extra": {
+        "branch-alias": {
+            "dev-master": "2.1.x-dev",
+            "dev-develop": "2.2.x-dev"
+        }
     }
 }

phpcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<ruleset name="Zend Framework Coding Standard">
+    <rule ref="./vendor/zendframework/zend-coding-standard/ruleset.xml"/>
+
+    <file>src</file>
+    <file>test</file>
+</ruleset>

phpunit.xml.dist

@@ -1,13 +1,17 @@
-<phpunit bootstrap="vendor/autoload.php" colors="true">
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true">
     <testsuites>
         <testsuite name="ZendService Google Gcm Test Suite">
-            <directory>./tests</directory>
+            <directory>./test</directory>
         </testsuite>
     </testsuites>
 
-    <groups>
-        <exclude>
-            <group>disable</group>
-        </exclude>
-    </groups>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
 </phpunit>

library/Gcm/Client.php → src/Gcm/Client.php

@@ -60,7 +60,7 @@ public function getApiKey()
      */
     public function setApiKey($apiKey)
     {
-        if (!is_string($apiKey) || empty($apiKey)) {
+        if (! is_string($apiKey) || empty($apiKey)) {
             throw new Exception\InvalidArgumentException('The api key must be a string and not empty');
         }
         $this->apiKey = $apiKey;
@@ -77,7 +77,7 @@ public function setApiKey($apiKey)
      */
     public function getHttpClient()
     {
-        if (!$this->httpClient) {
+        if (! $this->httpClient) {
             $this->httpClient = new HttpClient();
             $this->httpClient->setOptions(['strictredirects' => true]);
         }
@@ -119,7 +119,8 @@ public function send(Message $message)
         $client = $this->getHttpClient();
         $client->setUri(self::SERVER_URI);
         $headers = $client->getRequest()->getHeaders();
-        $headers->addHeaderLine('Authorization', 'key='.$this->getApiKey());
+        $headers->addHeaderLine('Authorization', 'key=' . $this->getApiKey());
+        $headers->addHeaderLine('Content-length', mb_strlen($message->toJson()));
 
         $response = $client->setHeaders($headers)
                            ->setMethod('POST')
@@ -146,7 +147,7 @@ public function send(Message $message)
                 break;
         }
 
-        if (!$response = Json::decode($response->getBody(), Json::TYPE_ARRAY)) {
+        if (! $response = Json::decode($response->getBody(), Json::TYPE_ARRAY)) {
             throw new Exception\RuntimeException('Response body did not contain a valid JSON response');
         }
 

library/Gcm/Message.php → src/Gcm/Message.php

@@ -108,10 +108,10 @@ public function getRegistrationIds()
      */
     public function addRegistrationId($id)
     {
-        if (!is_string($id) || empty($id)) {
+        if (! is_string($id) || empty($id)) {
             throw new Exception\InvalidArgumentException('$id must be a non-empty string');
         }
-        if (!in_array($id, $this->registrationIds)) {
+        if (! in_array($id, $this->registrationIds)) {
             $this->registrationIds[] = $id;
         }
 
@@ -151,7 +151,7 @@ public function getCollapseKey()
      */
     public function setCollapseKey($key)
     {
-        if (null !== $key && !(is_string($key) && strlen($key) > 0)) {
+        if (null !== $key && ! (is_string($key) && strlen($key) > 0)) {
             throw new Exception\InvalidArgumentException('$key must be null or a non-empty string');
         }
         $this->collapseKey = $key;
@@ -178,7 +178,7 @@ public function getPriority()
      */
     public function setPriority($priority)
     {
-        if (!is_null($priority) && !(is_string($priority) && strlen($priority) > 0)) {
+        if (! is_null($priority) && ! (is_string($priority) && strlen($priority) > 0)) {
             throw new Exception\InvalidArgumentException('$priority must be null or a non-empty string');
         }
         $this->priority = $priority;
@@ -227,7 +227,7 @@ public function getData()
      */
     public function addData($key, $value)
     {
-        if (!is_string($key) || empty($key)) {
+        if (! is_string($key) || empty($key)) {
             throw new Exception\InvalidArgumentException('$key must be a non-empty string');
         }
         if (array_key_exists($key, $this->data)) {
@@ -286,7 +286,7 @@ public function getNotification()
      */
     public function addNotification($key, $value)
     {
-        if (!is_string($key) || empty($key)) {
+        if (! is_string($key) || empty($key)) {
             throw new Exception\InvalidArgumentException('$key must be a non-empty string');
         }
         if (array_key_exists($key, $this->notification)) {
@@ -367,7 +367,7 @@ public function getTimeToLive()
      */
     public function setRestrictedPackageName($name)
     {
-        if (null !== $name && !(is_string($name) && strlen($name) > 0)) {
+        if (null !== $name && ! (is_string($name) && strlen($name) > 0)) {
             throw new Exception\InvalidArgumentException('$name must be null OR a non-empty string');
         }
         $this->restrictedPackageName = $name;

library/Gcm/Response.php → src/Gcm/Response.php

@@ -37,6 +37,24 @@ class Response
      */
     const RESULT_CANONICAL = 'registration_id';
 
+    /**
+     * Error field responses
+     * @link https://developers.google.com/cloud-messaging/http-server-ref#error-codes
+     * @var string
+     */
+    const ERROR_MISSING_REGISTRATION         = 'MissingRegistration';
+    const ERROR_INVALID_REGISTRATION         = 'InvalidRegistration';
+    const ERROR_NOT_REGISTERED               = 'NotRegistered';
+    const ERROR_INVALID_PACKAGE_NAME         = 'InvalidPackageName';
+    const ERROR_MISMATCH_SENDER_ID           = 'MismatchSenderId';
+    const ERROR_MESSAGE_TOO_BIG              = 'MessageTooBig';
+    const ERROR_INVALID_DATA_KEY             = 'InvalidDataKey';
+    const ERROR_INVALID_TTL                  = 'InvalidTtl';
+    const ERROR_UNAVAILABLE                  = 'Unavailable';
+    const ERROR_INTERNAL_SERVER_ERROR        = 'InternalServerError';
+    const ERROR_DEVICE_MESSAGE_RATE_EXCEEDED = 'DeviceMessageRateExceeded';
+    const ERROR_TOPICS_MESSAGE_RATE_EXCEEDED = 'TopicsMessageRateExceeded';
+
     /**
      * @var int
      */
@@ -138,7 +156,13 @@ public function getResponse()
      */
     public function setResponse(array $response)
     {
-        if (!isset($response['results'], $response['success'], $response['failure'], $response['canonical_ids'], $response['multicast_id'])) {
+        if (! isset(
+            $response['results'],
+            $response['success'],
+            $response['failure'],
+            $response['canonical_ids'],
+            $response['multicast_id']
+        )) {
             throw new Exception\InvalidArgumentException('Response did not contain the proper fields');
         }