pushy 2.0.11 → 2.0.14

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,448 +17,24 @@ 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;
-
-            // Callback?
-            if (callback) {
-                // Pass push ID to callback with a null error
-                callback(null, pushId);
-            }
-            else {
-                // Resolve the promise
-                resolve(pushId);
-            }
-        });
-    });
-};
-
-// Notification Deletion API
-Pushy.prototype.deletePushNotification = 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.'));
-        }
-
-        // 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);
-            }
-
-            // 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();
-            }
-        });
-    });
-};
-
-// Pub/Sub Subscribers API
-Pushy.prototype.getSubscribers = function (topic, callback) {
-    // Keep track of instance 'this'
-    var that = this;
-
-    // Always return a promise
-    return new Promise((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'));
-        }
-
-        // Build URL to Pub/Sub Subscribers API
-        var endPoint = that.getApiEndpoint() + '/topics/' + topic + '?api_key=' + that.apiKey;
-
-        // Make the request
-        request(
-            Object.assign({
-                uri: endPoint,
-                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);
-            }
-        });
-    });
-}
-
-// Pub/Sub Topics API
-Pushy.prototype.getTopics = function (callback) {
-    // Keep track of instance 'this'
-    var that = this;
-
-    // Always return a promise
-    return new Promise((resolve, reject) => {
-        // Custom callback provided?
-        if (callback) {
-            resolve = callback;
-            reject = callback;
-        }
-
-        // Build URL to Pub/Sub Topics API
-        var endPoint = that.getApiEndpoint() + '/topics/' + '?api_key=' + that.apiKey;
-
-        // Make the request
-        request(
-            Object.assign({
-                uri: endPoint,
-                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);
-            }
-        });
-    });
-}
-
-// Pub/Sub Subscribe API
-Pushy.prototype.subscribe = 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.'));
-        }
-
-        // Build URL to Pub/Sub Subscribe API
-        var endPoint = that.getApiEndpoint() + '/topics/subscribe/' + '?api_key=' + that.apiKey;
-
-        // 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 the request
-        request(
-            Object.assign({
-                uri: endPoint,
-                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();
-                }
-            });
-   });
-}
-
-// Pub/Sub Unsubscribe API
-Pushy.prototype.unsubscribe = 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.'));
-        }
-
-        // Build URL to Pub/Sub Unsubscribe API
-        var endPoint = that.getApiEndpoint() + '/topics/unsubscribe/' + '?api_key=' + that.apiKey;
-
-        // 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];
+// Push APIs
+Pushy.prototype.sendPushNotification = require('./api/push/send');
+Pushy.prototype.getNotificationStatus = require('./api/push/status');
+Pushy.prototype.deletePushNotification = require('./api/push/delete');
 
-        // Make the request
-        request(
-            Object.assign({
-                uri: endPoint,
-                method: 'POST',
-                json: postData
-            }, that.extraRequestOptions || {}), function (err, res, body) {
-                // Request error?
-                if (err) {
-                    // Send to callback
-                    return reject(err);
-                }
+// Device APIs
+Pushy.prototype.getDeviceInfo = require('./api/device/info');
+Pushy.prototype.getDevicePresence = require('./api/device/presence');
 
-                // Missing body?
-                if (!body) {
-                    return reject(new Error('An empty body was received from the Pushy API.'));
-                }
+// 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');
 
-                // 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();
-                }
-            });
-   });
+// API endpoint selector
+Pushy.prototype.getApiEndpoint = function () {
+    return (this.enterpriseEndpoint) ? this.enterpriseEndpoint : apiEndpoint;
 }
 
 // Support for Pushy Enterprise
@@ -469,15 +42,10 @@ 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.11",
+  "version": "2.0.14",
   "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 + ')');
-});