pushy 2.0.10 → 2.0.13

package/README.md

@@ -5,7 +5,7 @@ The official Node.js package for sending push notifications with [Pushy](https:/
 
 > [Pushy](https://pushy.me/) is the most reliable push notification gateway, perfect for real-time, mission-critical applications.
 
-**Note:** If you don't have an existing Node.js project, consider using our [sample Node.js API project](https://github.com/pushy-me/pushy-node-backend) as a starting point to make things easier for you.
+**Note:** If you don't have an existing Node.js project, consider using our [Node.js backend API sample project](https://github.com/pushy/pushy-node-backend) as a starting point to make things easier for you.
 
 ## Usage
 
@@ -15,13 +15,13 @@ First, install the package using npm:
 npm install pushy --save
 ```
 
-Then, use the following sample code to send a push notification to target devices:
+Then, use the following code to send a push notification to target devices using the [Send Notifications API](https://pushy.me/docs/api/send-notifications):
 
 ```js
 var Pushy = require('pushy');
 
 // Plug in your Secret API Key
-// Get it here: https://dashboard.pushy.me/
+// Get it from the Pushy Dashboard: https://dashboard.pushy.me/apps
 var pushy = new Pushy('SECRET_API_KEY');
 
 // Set push payload data to deliver to device(s)
@@ -29,8 +29,8 @@ var data = {
     message: 'Hello World!'
 };
 
-// Insert target device token(s) here
-var tokens = ['DEVICE_TOKEN'];
+// Insert target device token(s), or set to Pub/Sub topic
+var to = ['DEVICE_TOKEN'];
 
 // Set optional push notification options (such as iOS notification fields)
 var options = {
@@ -41,12 +41,11 @@ var options = {
     },
 };
 
-// Send push notification via the Send Notifications API
-// https://pushy.me/docs/api/send-notifications
-pushy.sendPushNotification(data, tokens, options, function (err, id) {
+// Send push notification using the Send Notifications API
+pushy.sendPushNotification(data, to, options, function (err, id) {
     // Log errors to console
     if (err) {
-        return console.log('Fatal Error', err);
+        return console.error(err);
     }
     
     // Log success
@@ -54,7 +53,11 @@ pushy.sendPushNotification(data, tokens, options, function (err, id) {
 });
 ```
 
-Alternatively, send the notification using promises:
+**Note:** Make sure to replace `SECRET_API_KEY` with your app's Secret API Key, available in the [Pushy Dashboard](https://dashboard.pushy.me/apps) (Click your app -> API Authentication tab). 
+
+--- 
+
+The library also supports using promise syntax instead of callbacks for all API methods:
 
 ```js
 pushy.sendPushNotification(data, tokens, options)
@@ -63,29 +66,160 @@ pushy.sendPushNotification(data, tokens, options)
         console.log('Push sent successfully! (ID: ' + id + ')');
     }).catch(function (err) {
         // Log errors to console
-        return console.log(err);
+        return console.error(err);
     });
 ```
 
-Make sure to replace `SECRET_API_KEY` with your app's Secret API Key listed in the [Dashboard](https://dashboard.pushy.me/). 
-
 ---
 
-To delete a notification (using the [Notification Deletion API](https://pushy.me/docs/api/notification-deletion)):
+# Push APIs
+
+## pushy.sendPushNotification(data, to, options)
+
+Instantly send push notifications to your users using the [Send Notifications API](https://pushy.me/docs/api/send-notifications) (see example above):
+
+```js
+pushy.sendPushNotification(data, to, options, function (err, id) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+    
+    // Log success
+    console.log('Push sent successfully! (ID: ' + id + ')');
+});
+```
+
+## pushy.getNotificationStatus(pushId)
+
+Check the delivery status of your push notifications using the [Notification Status API](https://pushy.me/docs/api/notification-status):
 
 ```js
-// Enter unique push ID returned from pushy.sendPushNotification()
-var pushId = '5ea9b214b47cad768a35f13a';
+pushy.getNotificationStatus('PUSH_ID', function (err, status) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
 
-// Delete the notification
-pushy.deletePushNotification(pushId)
-    .then(function (id) {
-        // Log success
-        console.log('Push deleted successfully!');
-    }).catch(function (err) {
-        // Log errors to console
-        return console.log(err);
-    });
+    // Log notification status
+    console.log('Notification Status: ', JSON.stringify(status, null, 2));
+});
+```
+
+## pushy.deletePushNotification(pushId)
+
+Permanently delete a pending notification using the [Notification Deletion API](https://pushy.me/docs/api/notification-deletion):
+
+```js
+pushy.deletePushNotification('PUSH_ID', function (err) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log success
+    console.log('Pending notification deleted successfully');
+});
+```
+
+# Device APIs
+
+## pushy.getDeviceInfo(deviceToken)
+
+Fetch device info, presence, undelivered notifications, and more by device token using the [Device Info API](https://pushy.me/docs/api/device):
+
+```js
+pushy.getDeviceInfo('DEVICE_TOKEN', function (err, deviceInfo) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log device info
+    console.log('Device Info: ', JSON.stringify(deviceInfo, null, 2));
+});
+```
+
+## pushy.getDevicePresence(deviceTokens)
+
+Check the presence and connectivity status of multiple devices using the [Device Presence API](https://pushy.me/docs/api/device-presence):
+
+```js
+pushy.getDevicePresence(['DEVICE_TOKEN', 'DEVICE_TOKEN_2'], function (err, devicePresence) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log device presence array
+    console.log('Device Presence: ', JSON.stringify(devicePresence, null, 2));
+});
+```
+
+# Pub/Sub APIs
+
+## pushy.getTopics()
+
+Retrieve a list of your app's topics and subscribers count using the [Pub/Sub Topics API](https://pushy.me/docs/api/pubsub-topics):
+
+```js
+pushy.getTopics(function (err, topics) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log subscribed topics
+    console.log('Subscribed topics: \n' + JSON.stringify(topics, null, 2));
+});
+```
+
+## pushy.getSubscribers(topic)
+
+Retrieve a list of devices subscribed to a certain topic using the [Pub/Sub Subscribers API](https://pushy.me/docs/api/pubsub-subscribers):
+
+```js
+pushy.getSubscribers('news', function (err, subscribers) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log subscribed devices
+    console.log('Devices subscribed to topic: \n' + JSON.stringify(subscribers, null, 2));
+});
+```
+
+## pushy.subscribe(topics, deviceToken)
+
+Subscribe a device to one or more topics using the [Pub/Sub Subscribe API](https://pushy.me/docs/api/pubsub-subscribe):
+
+```js
+pushy.subscribe(['news', 'weather'], 'DEVICE_TOKEN', function (err) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log success
+    console.log('Subscribed device to topic(s) successfully');
+});
+```
+
+## pushy.unsubscribe(topics, deviceToken)
+
+Unsubscribe a device from one or more topics using the [Pub/Sub Unsubscribe API](https://pushy.me/docs/api/pubsub-unsubscribe)
+
+```js
+pushy.unsubscribe(['news', 'weather'], 'DEVICE_TOKEN', function (err) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log success
+    console.log('Unsubscribed device from topic(s) successfully');
+});
 ```
 
 ## License

package/api/device/info.js

@@ -0,0 +1,64 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Device Info API
+module.exports = function (deviceToken, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // Device token passed in must be a string
+        if (typeof deviceToken !== 'string') {
+            return reject(new Error('Please provide the device token as a string.'));
+        }
+
+        // Make a request to the Device Info API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/devices/' + deviceToken + '?api_key=' + that.apiKey,
+                method: 'GET',
+                json: true
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Fetch result
+                var deviceInfo = body;
+
+                // Callback?
+                if (callback) {
+                    // Invoke callback with device info result
+                    callback(null, deviceInfo);
+                }
+                else {
+                    // Resolve the promise
+                    resolve(deviceInfo);
+                }
+            });
+    });
+}

package/api/device/presence.js

@@ -0,0 +1,84 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Device Presence API
+module.exports = function (deviceTokens, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // Topics passed in must be in string or array format
+        if (!Array.isArray(deviceTokens)) {
+            // In case a single token was passed in, convert to array
+            if (typeof deviceTokens === 'string') {
+                deviceTokens = [deviceTokens];
+            }
+            else {
+                // Throw error for all other input types
+                return reject(new Error('Please provide the device token parameter as an array of strings.'));
+            }
+        }
+
+        // Validate every device token to be a string
+        for (var deviceToken of deviceTokens) {
+            if (typeof deviceToken !== 'string') {
+                return reject(new Error('Please ensure all device tokens passed in are strings.'));
+            }
+        }
+
+        // Prepare JSON post data
+        var postData = {};
+
+        // Add devices tokens to the post body
+        postData.tokens = deviceTokens;
+
+        // Make a request to the Device Presence API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/devices/presence' + '?api_key=' + that.apiKey,
+                method: 'POST',
+                json: postData
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Fetch result
+                var devicePresence = body.presence;
+
+                // Callback?
+                if (callback) {
+                    // Invoke callback with device presence result
+                    callback(null, devicePresence);
+                }
+                else {
+                    // Resolve the promise
+                    resolve(devicePresence);
+                }
+            });
+    });
+}

package/api/pubsub/subscribe.js

@@ -0,0 +1,75 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Pub/Sub Subscribe API
+module.exports = function (topics, deviceToken, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // Device token passed in must be a string
+        if (typeof deviceToken !== 'string') {
+            return reject(new Error('Please provide the device token as a string.'));
+        }
+
+        // Topics passed in must be in string or array format
+        if (typeof topics !== 'string' && !Array.isArray(topics)) {
+            return reject(new Error('Please provide the Pub/Sub topics parameter as a string or an array of strings.'));
+        }
+
+        // Prepare JSON post data
+        var postData = {};
+
+        // Add token to the post body
+        postData.token = deviceToken;
+
+        // Convert singular string topic to array
+        postData.topics = Array.isArray(topics) ? topics : [topics];
+
+        // Make a request to the Pub/Sub Subscribe API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/topics/subscribe/' + '?api_key=' + that.apiKey,
+                method: 'POST',
+                json: postData
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Callback?
+                if (callback) {
+                    // Pass null error (success)
+                    callback(null);
+                }
+                else {
+                    // Resolve the promise successfully
+                    resolve();
+                }
+            });
+    });
+}

package/api/pubsub/subscribers.js

@@ -0,0 +1,64 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Pub/Sub Subscribers API
+module.exports = function (topic, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // Check the validity of topic
+        if (!topic || typeof topic !== 'string') {
+            return reject(new Error('Invalid topic name'));
+        }
+
+        // Make a request to the Pub/Sub Subscribers API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/topics/' + topic + '?api_key=' + that.apiKey,
+                method: 'GET',
+                json: true
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Fetch result
+                var subscribers = body.subscribers;
+
+                // Callback?
+                if (callback) {
+                    // Invoke callback with subscribers list
+                    callback(null, subscribers);
+                }
+                else {
+                    // Resolve the promise
+                    resolve(body);
+                }
+            });
+    });
+}

package/api/pubsub/topics.js

@@ -0,0 +1,59 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Pub/Sub Topics API
+module.exports = function (callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // Make a request to the Pub/Sub Topics API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/topics/' + '?api_key=' + that.apiKey,
+                method: 'GET',
+                json: true
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Fetch result
+                var topics = body.topics;
+
+                // Callback?
+                if (callback) {
+                    // Invoke callback with topics list
+                    callback(null, topics);
+                }
+                else {
+                    // Resolve the promise
+                    resolve(body);
+                }
+            });
+    });
+}

package/api/pubsub/unsubscribe.js

@@ -0,0 +1,75 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Pub/Sub Unsubscribe API
+module.exports = function (topics, deviceToken, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // Device token passed in must be a string
+        if (typeof deviceToken !== 'string') {
+            return reject(new Error('Please provide the device token as a string.'));
+        }
+
+        // Topics passed in must be in string or array format
+        if (typeof topics !== 'string' && !Array.isArray(topics)) {
+            return reject(new Error('Please provide the Pub/Sub topics parameter as a string or an array of strings.'));
+        }
+
+        // Prepare JSON post data
+        var postData = {};
+
+        // Add token to the post body
+        postData.token = deviceToken;
+
+        // Convert singular string topic to array
+        postData.topics = Array.isArray(topics) ? topics : [topics];
+
+        // Make a request to the Pub/Sub Unsubscribe API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/topics/unsubscribe/' + '?api_key=' + that.apiKey,
+                method: 'POST',
+                json: postData
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Callback?
+                if (callback) {
+                    // Pass null error (success)
+                    callback(null);
+                }
+                else {
+                    // Resolve the promise successfully
+                    resolve();
+                }
+            });
+    });
+}

package/api/push/delete.js

@@ -0,0 +1,71 @@
+var request = require('request');
+var Promise = require('bluebird')
+
+// Notification Deletion API
+module.exports = function (pushId, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // No pushId provided?
+        if (!pushId) {
+            return reject(new Error('Please provide the notification ID you wish to delete.'));
+        }
+
+        // pushId must be an string
+        if (typeof pushId !== 'string') {
+            return reject(new Error('Please provide the notification ID as a string.'));
+        }
+
+        // Callback must be a function (if provided)
+        if (callback && typeof callback !== 'function') {
+            return reject(new Error('Please provide the callback parameter as a function.'));
+        }
+
+        // Make a request to the Notification Deletion API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/pushes/' + pushId + '?api_key=' + that.apiKey,
+                method: 'DELETE',
+                json: true
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Callback?
+                if (callback) {
+                    // Invoke callback with a null error
+                    callback(null);
+                }
+                else {
+                    // Resolve the promise
+                    resolve();
+                }
+            });
+    });
+};

package/api/push/send.js

@@ -0,0 +1,103 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Send Notifications API
+module.exports = function (data, recipient, options, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Support empty options
+    options = options || {};
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // No data provided?
+        if (!data) {
+            return reject(new Error('Please provide the push payload to send to devices.'));
+        }
+
+        // Data must be an object
+        if ((Object.prototype.toString.call(data) !== '[object Object]')) {
+            return reject(new Error('Please provide the push payload as an object.'));
+        }
+
+        // No recipient provided?
+        if (!recipient) {
+            return reject(new Error('Please provide the notification recipient.'));
+        }
+
+        // Options must be an object
+        if (Object.prototype.toString.call(options) !== '[object Object]') {
+            return reject(new Error('Please provide the options parameter as an object.'));
+        }
+
+        // Prepare JSON post data (defaults to options object)
+        var postData = options;
+
+        // Set payload and device tokens
+        postData.data = data;
+
+        // Recipient provided as string?
+        if (typeof recipient === 'string' || Array.isArray(recipient)) {
+            // Set "to" parameter
+            postData.to = recipient;
+        }
+        else {
+            // Invalid recipient type
+            return reject(new Error('Please provide the notification recipient as a string or an array of strings.'));
+        }
+
+        // Callback must be a function (if provided)
+        if (callback && typeof callback !== 'function') {
+            return reject(new Error('Please provide the callback parameter as a function.'));
+        }
+
+        // Make a request to the Send Notifications API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/push?api_key=' + that.apiKey,
+                method: 'POST',
+                json: postData
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Fetch push notification ID
+                var pushId = body.id;
+
+                // Callback?
+                if (callback) {
+                    // Pass push ID to callback with a null error
+                    callback(null, pushId);
+                }
+                else {
+                    // Resolve the promise
+                    resolve(pushId);
+                }
+            });
+    });
+};

package/api/push/status.js

@@ -0,0 +1,64 @@
+var request = require('request');
+var Promise = require('bluebird');
+
+// Notification Status API
+module.exports = function (pushId, callback) {
+    // Keep track of instance 'this'
+    var that = this;
+
+    // Always return a promise
+    return new Promise(function (resolve, reject) {
+        // Custom callback provided?
+        if (callback) {
+            resolve = callback;
+            reject = callback;
+        }
+
+        // Device token passed in must be a string
+        if (typeof pushId !== 'string') {
+            return reject(new Error('Please provide the device token as a string.'));
+        }
+
+        // Make a request to the Notification Status API
+        request(
+            Object.assign({
+                uri: that.getApiEndpoint() + '/pushes/' + pushId + '?api_key=' + that.apiKey,
+                method: 'GET',
+                json: true
+            }, that.extraRequestOptions || {}), function (err, res, body) {
+                // Request error?
+                if (err) {
+                    // Send to callback
+                    return reject(err);
+                }
+
+                // Missing body?
+                if (!body) {
+                    return reject(new Error('An empty body was received from the Pushy API.'));
+                }
+
+                // Pushy error?
+                if (body.error) {
+                    return reject(new Error(body.error));
+                }
+
+                // Check for 200 OK
+                if (res.statusCode != 200) {
+                    return reject(new Error('An invalid response code was received from the Pushy API.'));
+                }
+
+                // Fetch result
+                var status = body.push;
+
+                // Callback?
+                if (callback) {
+                    // Invoke callback with notification status
+                    callback(null, status);
+                }
+                else {
+                    // Resolve the promise
+                    resolve(status);
+                }
+            });
+    });
+}

package/examples/device.js

@@ -0,0 +1,28 @@
+// Change to require('pushy') to use this code in your own project
+var Pushy = require('../');
+
+// Plug in your Secret API Key
+// Get it from the Pushy Dashboard: https://dashboard.pushy.me/apps
+var pushy = new Pushy('SECRET_API_KEY');
+
+// Fetch device info, presence, undelivered notifications, and more by device token
+pushy.getDeviceInfo('DEVICE_TOKEN', function (err, deviceInfo) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log device info
+    console.log('Device Info: ', JSON.stringify(deviceInfo, null, 2));
+});
+
+// Check the presence and connectivity status of multiple devices
+pushy.getDevicePresence(['DEVICE_TOKEN', 'DEVICE_TOKEN_2'], function (err, devicePresence) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log device presence array
+    console.log('Device Presence: ', JSON.stringify(devicePresence, null, 2));
+});

package/examples/pubsub.js

@@ -0,0 +1,50 @@
+// Change to require('pushy') to use this code in your own project
+var Pushy = require('../');
+
+// Plug in your Secret API Key
+// Get it from the Pushy Dashboard: https://dashboard.pushy.me/apps
+var pushy = new Pushy('SECRET_API_KEY');
+
+// Retrieve a list of your app's topics and subscribers count using the Pub/Sub Topics API
+pushy.getTopics(function (err, topics) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log subscribed topics
+    console.log('Subscribed topics: \n' + JSON.stringify(topics, null, 2));
+});
+
+// Retrieve a list of devices subscribed to a certain topic using the Pub/Sub Subscribers API
+pushy.getSubscribers('news', function (err, subscribers) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log subscribed devices
+    console.log('Devices subscribed to topic: \n' + JSON.stringify(subscribers, null, 2));
+});
+
+// Subscribe a device to one or more topics using the Pub/Sub Subscribe API
+pushy.subscribe(['news', 'weather'], 'DEVICE_TOKEN', function (err) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log success
+    console.log('Subscribed device to topic(s) successfully');
+});
+
+// Unsubscribe a device from one or more topics using the Pub/Sub Unsubscribe API
+pushy.unsubscribe(['news', 'weather'], 'DEVICE_TOKEN', function (err) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log success
+    console.log('Unsubscribed device from topic(s) successfully');
+});

package/examples/push.js

@@ -0,0 +1,56 @@
+// Change to require('pushy') to use this code in your own project
+var Pushy = require('../');
+
+// Plug in your Secret API Key
+// Get it from the Pushy Dashboard: https://dashboard.pushy.me/apps
+var pushy = new Pushy('SECRET_API_KEY');
+
+// Set push payload data to deliver to device(s)
+var data = {
+    message: 'Hello World!'
+};
+
+// Insert target device token(s), or set to Pub/Sub topic
+var to = ['DEVICE_TOKEN'];
+
+// Set optional push notification options (such as iOS notification fields)
+var options = {
+    notification: {
+        badge: 1,
+        sound: 'ping.aiff',
+        body: 'Hello World \u270c'
+    },
+};
+
+// Send push notification using the Send Notifications API
+pushy.sendPushNotification(data, to, options, function (err, id) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log success
+    console.log('Push sent successfully! (ID: ' + id + ')');
+});
+
+// Check the delivery status of your push notifications using the Notification Status API
+pushy.getNotificationStatus('PUSH_ID', function (err, status) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log notification status
+    console.log('Notification Status: ', JSON.stringify(status, null, 2));
+});
+
+// Permanently delete a pending notification using the Notification Deletion API
+pushy.deletePushNotification('PUSH_ID', function (err) {
+    // Log errors to console
+    if (err) {
+        return console.error(err);
+    }
+
+    // Log success
+    console.log('Pending notification deleted successfully');
+});

package/index.js

@@ -1,14 +1,11 @@
-var request = require('request');
-var Promise = require('bluebird');
-
 // Pushy API endpoint
 var apiEndpoint = 'https://api.pushy.me';
 
 // Package constructor
 function Pushy(apiKey) {
-    // Make sure the developer provided his/her API key
+    // Make sure the developer provided an API key
     if (!apiKey) {
-        throw new Error('Please provide your API key to use this package.');
+        throw new Error('Please provide your Secret API key to use this package.');
     }
 
     // Check for alphanumeric API key
@@ -20,177 +17,35 @@ function Pushy(apiKey) {
     this.apiKey = apiKey;
 }
 
-// Send Notifications API
-Pushy.prototype.sendPushNotification = function (data, recipient, options, callback) {
-    // Keep track of instance 'this'
-    var that = this;
-
-    // Support empty options
-    options = options || {};
-
-    // Always return a promise
-    return new Promise(function (resolve, reject) {
-        // Custom callback provided?
-        if (callback) {
-            resolve = callback;
-            reject = callback;
-        }
-
-        // No data provided?
-        if (!data) {
-            return reject(new Error('Please provide the push payload to send to devices.'));
-        }
-
-        // Data must be an object
-        if ((Object.prototype.toString.call(data) !== '[object Object]')) {
-            return reject(new Error('Please provide the push payload as an object.'));
-        }
-
-        // No recipient provided?
-        if (!recipient) {
-            return reject(new Error('Please provide the notification recipient.'));
-        }
-
-        // Options must be an object
-        if (Object.prototype.toString.call(options) !== '[object Object]') {
-            return reject(new Error('Please provide the options parameter as an object.'));
-        }
-        
-        // Prepare JSON post data (defaults to options object)
-        var postData = options;
-
-        // Set payload and device tokens
-        postData.data = data;
-
-        // Recipient provided as string?
-        if (typeof recipient === 'string' || Array.isArray(recipient)) {
-            // Set "to" parameter
-            postData.to = recipient;
-        }
-        else {
-            // Invalid recipient type
-            return reject(new Error('Please provide the notification recipient as a string or an array of strings.'));
-        }
-
-        // Callback must be a function (if provided)
-        if (callback && typeof callback !== 'function') {
-            return reject(new Error('Please provide the callback parameter as a function.'));
-        }
-
-        // Send push using the "request" package
-        request(Object.assign({
-            uri: that.getApiEndpoint() + '/push?api_key=' + that.apiKey,
-            method: 'POST',
-            json: postData
-        }, that.extraRequestOptions || {}), function (err, res, body) {
-            // Request error?
-            if (err) {
-                // Send to callback
-                return reject(err);
-            }
-
-            // Missing body?
-            if (!body) {
-                return reject(new Error('An empty body was received from the Pushy API.'));
-            }
-
-            // Pushy error?
-            if (body.error) {
-                return reject(new Error(body.error));
-            }
-
-            // Check for 200 OK
-            if (res.statusCode != 200) {
-                return reject(new Error('An invalid response code was received from the Pushy API.'));
-            }
-
-            // Fetch push notification ID
-            var pushId = body.id;
+// Push APIs
+Pushy.prototype.sendPushNotification = require('./api/push/send');
+Pushy.prototype.getNotificationStatus = require('./api/push/status');
+Pushy.prototype.deletePushNotification = require('./api/push/delete');
 
-            // Callback?
-            if (callback) {
-                // Pass push ID to callback with a null error
-                callback(null, pushId);
-            }
-            else {
-                // Resolve the promise
-                resolve(pushId);
-            }
-        });
-    });
-};
+// Device APIs
+Pushy.prototype.getDeviceInfo = require('./api/device/info');
+Pushy.prototype.getDevicePresence = require('./api/device/presence');
 
-// Notification Deletion API
-Pushy.prototype.deletePushNotification = function (pushId, callback) {
-    // Keep track of instance 'this'
-    var that = this;
+// Pub/Sub APIs
+Pushy.prototype.getTopics = require('./api/pubsub/topics');
+Pushy.prototype.subscribe = require('./api/pubsub/subscribe');
+Pushy.prototype.unsubscribe = require('./api/pubsub/unsubscribe');
+Pushy.prototype.getSubscribers = require('./api/pubsub/subscribers');
 
-    // Always return a promise
-    return new Promise(function (resolve, reject) {
-        // Custom callback provided?
-        if (callback) {
-            resolve = callback;
-            reject = callback;
-        }
-
-        // No pushId provided?
-        if (!pushId) {
-            return reject(new Error('Please provide the notification ID you wish to delete.'));
-        }
-
-        // pushId must be an string
-        if (typeof pushId !== 'string') {
-            return reject(new Error('Please provide the notification ID as a string.'));
-        }
-
-        // Callback must be a function (if provided)
-        if (callback && typeof callback !== 'function') {
-            return reject(new Error('Please provide the callback parameter as a function.'));
-        }
-
-        // Delete push using the "request" package
-        request(Object.assign({
-            uri: that.getApiEndpoint() + '/pushes/' + pushId + '?api_key=' + that.apiKey,
-            method: 'DELETE',
-        }, that.extraRequestOptions || {}), function (err, res, body) {
-            // Request error?
-            if (err) {
-                // Send to callback
-                return reject(err);
-            }
-
-            // Check for 200 OK
-            if (res.statusCode != 200) {
-                return reject(new Error('An invalid response code was received from the Pushy API.'));
-            }
-
-            // Callback?
-            if (callback) {
-                // Invoke callback with a null error
-                callback(null);
-            }
-            else {
-                // Resolve the promise
-                resolve();
-            }
-        });
-    });
-};
+// API endpoint selector
+Pushy.prototype.getApiEndpoint = function () {
+    return (this.enterpriseEndpoint) ? this.enterpriseEndpoint : apiEndpoint;
+}
 
 // Support for Pushy Enterprise
 Pushy.prototype.setEnterpriseConfig = function (endpoint) {
     this.enterpriseEndpoint = endpoint;
 }
 
-// API endpoint selector
-Pushy.prototype.getApiEndpoint = function () {
-    return (this.enterpriseEndpoint) ? this.enterpriseEndpoint : apiEndpoint;
-}
-
 // Add extra options that will be passed to the request library
 Pushy.prototype.setExtraRequestOptions = function (extraRequestOptions) {
     this.extraRequestOptions = extraRequestOptions;
 }
 
 // Expose the Pushy object
-module.exports = Pushy;
+module.exports = Pushy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pushy",
-  "version": "2.0.10",
+  "version": "2.0.13",
   "description": "The official Node.js package for sending push notifications with Pushy.",
   "main": "index.js",
   "scripts": {
@@ -8,14 +8,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/pushy-me/pushy-node.git"
+    "url": "git+https://github.com/pushy/pushy-node.git"
   },
   "author": "Pushy <support@pushy.me>",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/pushy-me/pushy-node/issues"
+    "url": "https://github.com/pushy/pushy-node/issues"
   },
-  "homepage": "https://github.com/pushy-me/pushy-node#readme",
+  "homepage": "https://github.com/pushy/pushy-node#readme",
   "dependencies": {
     "bluebird": "^3.4.1",
     "request": "^2.72.0"

package/examples/send.js

@@ -1,35 +0,0 @@
-// Change to require('pushy') to use this code in your own project
-var Pushy = require('../');
-
-// Plug in your Secret API Key
-// Get it here: https://dashboard.pushy.me/
-var pushy = new Pushy('SECRET_API_KEY');
-
-// Set push payload data to deliver to device(s)
-var data = {
-    message: 'Hello World!'
-};
-
-// Insert target device token(s) here
-var tokens = ['DEVICE_TOKEN'];
-
-// Set optional push notification options (such as iOS notification fields)
-var options = {
-    notification: {
-        badge: 1,
-        sound: 'ping.aiff',
-        body: 'Hello World \u270c'
-    },
-};
-
-// Send push notification via the Send Notifications API
-// https://pushy.me/docs/api/send-notifications
-pushy.sendPushNotification(data, tokens, options, function (err, id) {
-    // Log errors to console
-    if (err) {
-        return console.log('Fatal Error', err);
-    }
-    
-    // Log success
-    console.log('Push sent successfully! (ID: ' + id + ')');
-});