2.0.0 (aka 1.0.0)

.gitignore

@@ -11,6 +11,9 @@ pids
 logs
 results
 
+test.js
+
 node_modules
 npm-debug.log
 .idea
+.vscode

CHANGELOG.md

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+**1.0.0-alpha.1**
+ * Removed the Message abstraction, now expect plain objects.
+ * Smaller lodash dependency (only depending on the part that is used).
+ * Simplified the recipient argument so it is now closer to the actual API interface.
+ * Removed `sendNoRetry` method on sender --- use `send` with the option `retries: 0` instead.
+
+**1.0.0-alpha.0**
+ * Removed deprecated things: constants, Result, MulticastResult, Message#addDataWith...
+
 **0.14.2**
  * Updated README, added note on v1 development
 

README.md

@@ -9,8 +9,10 @@ If you are developing an open-source project with a broader scope (like a full F
 
 See the [official FCM documentation](https://firebase.google.com/docs/cloud-messaging/) for more information.
 
-We are currently working on version 1.0.0 of the project, and it is available in an early alpha version.
+This is the README for the `v1` branch, and it is currently work in progress.
+Version 1.0.0 is only available in an alpha version.
 Follow [PR #238](https://github.com/ToothlessGear/node-gcm/pull/238) to see current status.
+We currently recommend you use the mainline version of node-gcm (found on the master branch) for production.
 
 ## Installation
 
@@ -31,17 +33,14 @@ If you are new to GCM you should probably look into the [documentation](https://
 According to below **Usage** reference, we could create such application:
 
 ```js
-var gcm = require('node-gcm');
+var gcm = require('node-gcm')('YOUR_API_KEY_HERE');
 
-var message = new gcm.Message({
+var message = {
     data: { key1: 'msg1' }
-});
-
-// Set up the sender with you API key, prepare your recipients' registration tokens.
-var sender = new gcm.Sender('YOUR_API_KEY_HERE');
-var regTokens = ['YOUR_REG_TOKEN_HERE'];
+};
+var recipient = 'YOUR_REG_TOKEN_HERE';
 
-sender.send(message, { registrationTokens: regTokens }, function (err, response) {
+gcm.send(message, recipient, function (err, response) {
 	if(err) console.error(err);
 	else 	console.log(response);
 });
@@ -50,21 +49,17 @@ sender.send(message, { registrationTokens: regTokens }, function (err, response)
 ## Usage
 
 ```js
-var gcm = require('node-gcm');
+var gcm = require('node-gcm')('insert Google Server API Key here');
 
-// Create a message
-// ... with default values
-var message = new gcm.Message();
-
-// ... or some given values
-var message = new gcm.Message({
-	collapseKey: 'demo',
+// Create a message (all possible values shown)
+var message = {
+	collapse_key: 'demo',
 	priority: 'high',
-	contentAvailable: true,
-	delayWhileIdle: true,
-	timeToLive: 3,
-	restrictedPackageName: "somePackageName",
-	dryRun: true,
+	content_available: true,
+	delay_while_idle: true,
+	time_to_live: 3,
+	restricted_package_name: "somePackageName",
+	dry_run: true,
 	data: {
 		key1: 'message1',
 		key2: 'message2'
@@ -74,21 +69,7 @@ var message = new gcm.Message({
 		icon: "ic_launcher",
 		body: "This is a notification that will be displayed ASAP."
 	}
-});
-
-// Change the message data
-// ... as key-value
-message.addData('key1','message1');
-message.addData('key2','message2');
-
-// ... or as a data object (overwrites previous data object)
-message.addData({
-	key1: 'message1',
-	key2: 'message2'
-});
-
-// Set up the sender with you API key
-var sender = new gcm.Sender('insert Google Server API Key here');
+};
 
 // Add the registration tokens of the devices you want to send to
 var registrationTokens = [];
@@ -97,59 +78,42 @@ registrationTokens.push('regToken2');
 
 // Send the message
 // ... trying only once
-sender.sendNoRetry(message, { registrationTokens: registrationTokens }, function(err, response) {
+gcm.send(message, registrationTokens, { retries: 0 }, function(err, response) {
   if(err) console.error(err);
   else    console.log(response);
 });
 
 // ... or retrying
-sender.send(message, { registrationTokens: registrationTokens }, function (err, response) {
+gcm.send(message, registrationTokens, function (err, response) {
   if(err) console.error(err);
   else    console.log(response);
 });
 
 // ... or retrying a specific number of times (10)
-sender.send(message, { registrationTokens: registrationTokens }, 10, function (err, response) {
+gcm.send(message, registrationTokens, 10, function (err, response) {
   if(err) console.error(err);
   else    console.log(response);
 });
 ```
-## Recipients
-
-You can send push notifications to various recipient types by providing one of the following recipient keys:
-
 
-|Key|Type|Description|
-|---|---|---|
-|to|String|A single [registration token](https://developers.google.com/cloud-messaging/android/client#sample-register), [notification key](https://developers.google.com/cloud-messaging/notifications), or [topic](https://developers.google.com/cloud-messaging/topic-messaging).
-|topic|String|A single publish/subscribe topic.
-|notificationKey|String|Deprecated. A key that groups multiple registration tokens linked to the same user.
-|registrationIds|String[]|Deprecated. Use registrationTokens instead.|
-|registrationTokens|String[]|A list of registration tokens. Must contain at least 1 and at most 1000 registration tokens.|
+## Recipients
 
-If you provide an incorrect recipient key or object type, an `Error` object will be returned to your callback.
+You can send a push notification to various recipient or topic, by providing a notification key, registration token or topic as a string.
+Alternatively, you can send it to several recipients at once, by providing an array of registration tokens.
 
 Notice that [you can *at most* send notifications to 1000 registration tokens at a time](https://github.com/ToothlessGear/node-gcm/issues/42).
 This is due to [a restriction](http://developer.android.com/training/cloudsync/gcm.html) on the side of the GCM API.
 
 ## Notification usage
 
 ```js
-
-var message = new gcm.Message();
-
-// Add notification payload as key value
-message.addNotification('title', 'Alert!!!');
-message.addNotification('body', 'Abnormal data access');
-message.addNotification('icon', 'ic_launcher');
-
-// as object
-message.addNotification({
-  title: 'Alert!!!',
-  body: 'Abnormal data access',
-  icon: 'ic_launcher'
-});
-
+var message = {
+    notification: {
+        title: 'Alert!!!',
+        body: 'Abnormal data access',
+        icon: 'ic_launcher'
+    }
+};
 ```
 
 ### Notification payload option table
@@ -182,15 +146,15 @@ var requestOptions = {
 	timeout: 5000
 };
 
-// Set up the sender with your API key and request options
-var sender = new gcm.Sender('YOUR_API_KEY_HERE', requestOptions);
+// Set up gcm with your API key and request options
+var gcm = require("node-gcm")('YOUR_API_KEY_HERE', requestOptions);
 
 // Prepare a GCM message...
 
 // Send it to GCM endpoint with modified request options
-sender.send(message, { registrationTokens: regTokens }, function (err, response) {
+gcm.send(message, regTokens, function (err, response) {
     if(err) console.error(err);
-    else     console.log(response);
+    else    console.log(response);
 });
 ```
 

examples/notification.js

@@ -1,19 +1,21 @@
-var gcm = require('../lib/node-gcm');
-
-var message = new gcm.Message();
-
-message.addData('hello', 'world');
-message.addNotification('title', 'Hello');
-message.addNotification('icon', 'ic_launcher');
-message.addNotification('body', 'World');
+//Replace your developer API key with GCM enabled here
+var gcm = require('../index')('AIza*******************5O6FM');
 
+var message = {
+    data: {
+        hello: 'world'
+    },
+    notification: {
+        title: 'Hello',
+        icon: 'ic_launcher',
+        body: 'World'
+    }
+};
 
 //Add your mobile device registration tokens here
 var regTokens = ['ecG3ps_bNBk:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxXl7TDJkW'];
-//Replace your developer API key with GCM enabled here
-var sender = new gcm.Sender('AIza*******************5O6FM');
 
-sender.send(message, regTokens, function (err, response) {
+gcm.send(message, regTokens, function (err, response) {
     if(err) {
       console.error(err);
     } else {

lib/constants.js

@@ -8,21 +8,6 @@ var Constants = {
 
     /** DEPRECATED **/
 
-    'TOKEN_MESSAGE_ID' : 'id',
-    'TOKEN_CANONICAL_REG_ID' : 'registration_id',
-    'TOKEN_ERROR' : 'Error',
-    'JSON_REGISTRATION_IDS' : 'registration_ids',
-    'JSON_PAYLOAD' : 'data',
-    'JSON_NOTIFICATION' : 'notification',
-    'JSON_SUCCESS' : 'success',
-    'JSON_FAILURE' : 'failure',
-    'JSON_CANONICAL_IDS' : 'canonical_ids',
-    'JSON_MULTICAST_ID' : 'multicast_id',
-    'JSON_RESULTS' : 'results',
-    'JSON_ERROR' : 'error',
-    'JSON_MESSAGE_ID' : 'message_id',
-    'UTF8' : 'UTF-8',
-
     //These errors could probably be structured more nicely, and could be used in the code.
     // -- maybe just as an Error abstraction?
     'ERROR_QUOTA_EXCEEDED' : 'QuotaExceeded',

lib/message-options.js

@@ -1,43 +1,31 @@
 /**
  * This module defines all the arguments that may be passed to a message.
- * 
- * Each argument may contain a field `__argName`, if the name of the field
- * should be different when sent to the server.
- * 
- * The argument may also contain a field `__argType`, if the given
+ *
+ * Each argument may contain a field `__argType`, in which case the given
  * argument must be of that type. The types are the strings resulting from
  * calling `typeof <arg>` where `<arg>` is the argument.
- * 
- * Other than that, the arguments are expected to follow the indicated
- * structure.
  */
 
 module.exports = {
-	collapseKey: {
-        __argName: "collapse_key",
+	collapse_key: {
         __argType: "string"
     },
     priority: {
         __argType: "string"
     },
-    contentAvailable: {
-        __argName: "content_available",
+    content_available: {
         __argType: "boolean"
     },
-	delayWhileIdle: {
-        __argName: "delay_while_idle",
+	delay_while_idle: {
         __argType: "boolean"
     },
-    timeToLive: {
-        __argName: "time_to_live",
+    time_to_live: {
         __argType: "number"
     },
-    restrictedPackageName: {
-        __argName: "restricted_package_name",
+    restricted_package_name: {
         __argType: "string"
     },
-    dryRun: {
-        __argName: "dry_run",
+    dry_run: {
         __argType: "boolean"
     },
     data: {