yodel-gcm

yodel-gcm is a Node.JS library for Google Cloud Messaging for Android based on node-gcm.

Installation

$ npm install yodel-gcm

Requirements

An Android device running 2.2 or newer and an API key as per GCM getting started guide.

Usage

Standard Push Notifications

var gcm = require('yodel-gcm');

// Create a message
// ... with default values
var message = new gcm.Message();

// ... or some given values
var message = new gcm.Message({
	collapseKey: 'demo',
	delayWhileIdle: true,
	timeToLive: 3,
	data: {
		key1: 'message1',
		key2: 'message2'
	}
});

// 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'
});

// Change the message variables
message.collapseKey = 'demo';
message.delayWhileIdle = true;
message.timeToLive = 3;
message.dryRun = true;

// Set up the sender with you API key
var sender = new gcm.Sender('insert Google Server API Key here');

// Add the registration IDs of the devices you want to send to
var registrationIds = [];
registrationIds.push('regId1');
registrationIds.push('regId2');

// Send the message
// ... trying only once
sender.sendNoRetry(message, registrationIds, function(err, result) {
  if(err) console.error(err);
  else    console.log(result);
});

// ... or retrying
sender.send(message, registrationIds, function (err, result) {
  if(err) console.error(err);
  else    console.log(result);
});

// ... or retrying a specific number of times (10)
sender.send(message, registrationIds, 10, function (err, result) {
  if(err) console.error(err);
  else    console.log(result);
});

User Notifications

User notifications were initially introduced at Google I/O 2013 and became available to all developers in late 2014. At its core, user notifications provide developers a way to associate multiple devices to a single key (often associated with an individual app user). This adds a layer of notification key management but potentially removes the burden of maintaining a local list of all registration IDs for a particular user. Using notification keys also opens up the possibility of implementing upstream messaging. Further explanation can be found within the Official GCM User Notification docs. If you are new to user notifications, it is highly recommended that you read this guide for implementing User Notifications which explains some key points unmentioned in the official documentation.

Performing Notification Key Operations

var gcm = require('yodel-gcm');

// Create an operation runner for performing notification key operations
var opRunner = new gcm.OperationRunner(
  'insert Google project number here', 
  'insert Google Server API Key here'
  );

// Define a 'create' operation for creating a notification key
var createOperation = new gcm.Operation({
  operationType: 'create',
  notificationKeyName: 'appUser-Chris',
  registrationIds: ['regId1', 'regId2']
});

// Run the 'create' operation
opRunner.performOperation(createOperation, function(err, result) {
  if (err) console.error(err);
  if (result.notification_key) {
    // Store the notification key for later use. 
    // Each successful operation returns a notification_key, and
    // it is recommended that the stored notification key be updated
    // with the returned value.
  } else {
    console.error('Did not receive notification key');
  }
});

Operation Types

Create: Creates a new notification key with provided registration IDs

var createOperation = new gcm.Operation({
  operationType: 'create',
  notificationKeyName: 'appUser-Chris',
  registrationIds: ['regId1', 'regId2']
});

Add: Adds new registration IDs to an existing notification key

// Set recreateKeyIfMissing to true if you want to automatically retry as a
// create operation if GCM has deleted your original notification key.
var addOperation = new gcm.Operation({
  operationType: 'add',
  notificationKeyName: 'appUser-Chris',
  notificationKey: 'yourlongnotificationkeystring',
  registrationIds: ['regId2', 'regId3'],
  recreateKeyIfMissing: true
});

Remove: Removes registration IDs from an existing notification key

// A notification key will be automatically deleted if all registrationIDs are removed.
var addOperation = new gcm.Operation({
  operationType: 'remove',
  notificationKeyName: 'appUser-Chris',
  notificationKey: 'yournotificationkey',
  registrationIds: ['regId3']
});

Sending a Message via Notification Key

Sending a message using a notification key is nearly identical to sending a message with a registration ID array. However, rather than using Sender, you must use UserNotificationSender.

// Create a message
var message = new gcm.Message({data: {...}});
// Initiate a UserNotificationSender
var userSender  = new gcm.UserNotificationSender('insert Google Server API Key here');
    
userSender.send(message, 'yournotificationkey', function(err, results) {
  if (err) console.error(err);
  // Do something upon successful operation
});

Debug

To enable debug mode (print requests and responses to and from GCM), set the DEBUG environment flag when running your app (assuming you use node app.js to run your app):

DEBUG=yodel-gcm node app.js

Contributors

• monkbroc
• zlyinfinite
• Yann Biancheri
• Hamid Palo
• Dotan J.Nahum
• Olivier Poitrey
• Max Rabin
• George Miroshnykov
• Alejandro Garcia
• Ismael Gorissen
• Joris Verbogt
• goelvivek
• Lars Jacob
• Roman Iakovlev
• Roman Skvazh
• Jeremy Goldstein
• Adam Patacchiola
• Ivan Longin
• Paul Bininda
• Niels Roesen Abildgaard
• Brian Bowden

License

(The MIT License)

Copyright (c) 2013 Marcus Farkas <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

0.9.16-0.9.21

• added the full response body in addition to the error code when an error is returned to a callback during a send or operation
• various small tweaks and fixes

0.9.15

• added support for user notifications
• introduced OperationRunner and Operation to allow for notification key operations
• moved core 'send' logic to SenderBase to allow for backwards compatibility while sharing send logic
• moved from a registrationIds array in SenderBase to a recipient object that may contain regIds or a notification key
• rewrote Sender to be backwards compatible while extending SenderBase
• introduced UserNotificationSender (extending SenderBase) for sending notifications via notification key
• moved existing senderSpec.js tests ot senderBaseSpec.js and added support for new functionality
• rewrote senderSpec.js to perform simple tests to ensure proper data passback to SenderBase methods
• added a gruntfile and grunt dev dependency for automated testing
• updated README
• update contributors

0.9.14

• Message#addData is now multi-purpose (works as either Message#addDataWithObject or Message#addDataWithKeyValue)
• clarified README usage example
• clarified README debug section
• made Sender#send have a default of 5 retries (if none provided)

0.9.13

• print server responses on invalid requests while in debug mode
• fixed engine version in package.json (now correctly states >= 10)
• callbacks to Sender#send and Sender#sendNoRetry are now optional

0.9.12

• added debug module and removed console-logs
• use exponential retry instead of linear
• update request module with most recent compatible one
• remove require on global timers
• various cleanups
• add maxSockets option
• keep 'this' on Sender object in retries
• updated README
• updated contributors

0.9.11

• check >= 500 error status
• just reassign id array on err, don't iterate
• send err to callback
• resend if send multiple errs
• check for not result instead of result === undefined
• updated README
• updated contributors

0.9.10

• Added dryRun message parameter
• updated README
• updated contributors

0.9.9

• fix statusCode logging
• Added a call of a callback function in case when no registration id were given
• updated contributors

0.9.8

• Added support for sending POSTs to GCM through http/https proxies.
• updated contributors

0.9.7

• move callback outside of try catch block
• updated README
• updated contributors

0.9.6:

• fixed undefined "data" var
• made constructor argument optional
• added back addData method
• updated README
• updated contributors

0.9.5:

• change addData to addDataWithKeyValue
• add new function addDataWithObject
• message object can be initialised with another object
• updated contributors

0.9.4:

• fix TypeError
• updated contributors
• updated README

0.9.3:

• new callback-style (Please check the example above)
• fixes various issues (Read commit messages)
• not making a distinction between a single and multiple result makes it easier for application-land code to handle

0.9.2:

• added error handler to HTTPS request to handle DNS exceptions
• added multicast-messaging

0.9.1:

• first release