修正部分接口 promise 支持；使用 ES6 Promise 替代 when

Author: samurai00

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+
+## 2.1.2 (2018-05-14)
+#### 修正
+- 修正部分接口 promise 支持
+
+#### 更改
+- 使用 ES6 Promise 替代 when
+
 ## 2.1.1 (2018-01-10)
 #### 更改
 - 去除 transfer 取消接口

README.md

@@ -6,7 +6,7 @@ example 文件夹里面是一个简单的接入示例，该示例仅供参考。
 docs 接口文档
 
 ## 版本要求
-nodejs 版本 v0.8.0 及以上
+nodejs 版本 4 及以上
 
 ## 安装
 `npm install pingpp`  

VERSION

@@ -1 +1 @@
-2.1.1
+2.1.2

example/promise.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const API_KEY = 'sk_test_ibbTe5jLGCi5rzfH4OqPW9KC';
+
+var pingpp = require('../lib/pingpp')(API_KEY);
+var path = require('path');
+
+pingpp.setPrivateKeyPath(path.join(__dirname, 'your_rsa_private_key.pem'));
+
+pingpp.charges.retrieve(
+  'ch_bLWP80Ci9S4ODaXLSKLOGe5S'
+).then(ch => {
+  console.log(ch);
+}).catch(e => {
+  console.log(e);
+});

lib/PingppMethod.js

@@ -16,7 +16,7 @@ var OPTIONAL_REGEX = /^optional!/;
  */
 module.exports = function pingppMethod(spec) {
   var commandPath = typeof spec.path == 'function' ? spec.path
-                  : utils.makeURLInterpolator(spec.path || '');
+    : utils.makeURLInterpolator(spec.path || '');
   var requestMethod = (spec.method || 'GET').toUpperCase();
   var urlParams = spec.urlParams || [];
 
@@ -29,47 +29,52 @@ module.exports = function pingppMethod(spec) {
     var data = utils.isObject(args[args.length - 1]) ? args.pop() : {};
     var urlData = this.createUrlData();
 
-    var deferred = this.createDeferred(callback);
+    return this.wrapTimeout(new Promise((function (resolve, reject) {
+      for (var i = 0, l = urlParams.length; i < l; ++i) {
+        var err;
 
-    for (var i = 0, l = urlParams.length; i < l; ++i) {
+        var arg = args[0];
+        var param = urlParams[i];
 
-      var arg = args[0];
-      var param = urlParams[i];
+        var isOptional = OPTIONAL_REGEX.test(param);
+        param = param.replace(OPTIONAL_REGEX, '');
 
-      var isOptional = OPTIONAL_REGEX.test(param);
-      param = param.replace(OPTIONAL_REGEX, '');
-
-      if (!arg) {
-        if (isOptional) {
-          urlData[param] = '';
-          continue;
+        if (!arg) {
+          if (isOptional) {
+            urlData[param] = '';
+            continue;
+          }
+          err = new Error('Pingpp: I require argument "' + urlParams[i] + '", but I got: ' + arg);
+          reject(err);
+          return;
         }
-        throw new Error('Pingpp: I require argument "' + urlParams[i] + '", but I got: ' + arg);
-      }
 
-      urlData[param] = args.shift();
-    }
+        urlData[param] = args.shift();
+      }
 
-    if (args.length) {
-      throw new Error(
-        'Pingpp: Unknown arguments (' + args + '). Did you mean to pass an options object?'
-      );
-    }
+      if (args.length) {
+        err = new Error(
+          'Pingpp: Unknown arguments (' + args + '). Did you mean to pass an options object?'
+        );
+        reject(err);
+        return;
+      }
 
-    var requestPath = this.createFullPath(commandPath, urlData);
+      var requestPath = this.createFullPath(commandPath, urlData);
 
-    self._request(requestMethod, requestPath, data, auth, function(err, response) {
-      if (err) {
-        deferred.reject(err);
-      } else {
-        deferred.resolve(
-          spec.transformResponseData ?
-            spec.transformResponseData(response) :
-            response
-        );
+      function requestCallback(err, response) {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(
+            spec.transformResponseData ?
+              spec.transformResponseData(response) :
+              response
+          );
+        }
       }
-    });
 
-    return deferred.promise;
+      self._request(requestMethod, requestPath, data, auth, requestCallback);
+    }).bind(this)), callback);
   };
 };

lib/PingppResource.js

@@ -3,7 +3,6 @@
 var http = require('http');
 var https = require('https');
 var path = require('path');
-var when = require('when');
 var _ = require('lodash');
 
 var utils = require('./utils');
@@ -62,20 +61,17 @@ PingppResource.prototype = {
     return urlData;
   },
 
-  createDeferred: function(callback) {
-    var deferred = when.defer();
-
+  wrapTimeout: function(promise, callback) {
     if (callback) {
-      // Callback, if provided, is a simply translated to Promise'esque:
-      // (Ensure callback is called outside of promise stack)
-      deferred.promise.then(function(res) {
-        setTimeout(function(){ callback(null, res); }, 0);
+      // Ensure callback is called outside of promise stack.
+      return promise.then(function(res) {
+        setTimeout(function() { callback(null, res); }, 0);
       }, function(err) {
-        setTimeout(function(){ callback(err, null); }, 0);
+        setTimeout(function() { callback(err, null); }, 0);
       });
     }
 
-    return deferred;
+    return promise;
   },
 
   _timeoutHandler: function(timeout, req, callback) {

lib/pingpp.js

@@ -118,7 +118,7 @@ Pingpp.prototype = {
     if (id) {
       this._setApiField(
         'appID',
-         id
+        id
       );
     }
   },

lib/resources/BatchTransfers.js

@@ -18,9 +18,9 @@ module.exports = PingppResource.extend({
   }),
 
   cancel: function(id, callback){
-    this.update(id, {
+    return this.wrapTimeout(this.update(id, {
       'status': 'canceled'
-    }, callback);
+    }), callback);
   }
 
 });

lib/resources/Charges.js

@@ -13,20 +13,20 @@ module.exports = PingppResource.extend({
     'create', 'retrieve'
   ],
 
-  _listCharges: pingppMethod({
-    method: 'GET'
-  }),
-
-  list: function(params, cb) {
+  list: function(params, callback) {
     if (!hasOwn.call(params, 'app')
       || typeof params.app != 'object'
       || !hasOwn.call(params.app, 'id')
     ) {
-      cb.call(null, new Error.PingppInvalidRequestError({
-        message: 'Please pass app[id] as parameter.'
-      }));
+      return this.wrapTimeout(new Promise(function (resolve, reject) {
+        reject(new Error.PingppInvalidRequestError({
+          message: 'Please pass app[id] as parameter.'
+        }));
+      }), callback);
     } else {
-      this._listCharges(params, cb);
+      return pingppMethod({
+        method: 'GET'
+      });
     }
   },
 

lib/resources/Orders.js

@@ -17,10 +17,10 @@ module.exports = PingppResource.extend({
     urlParams: ['id']
   }),
 
-  cancel: function(id,callback){
-    this.update(id,{
+  cancel: function(id, callback) {
+    return this.wrapTimeout(this.update(id, {
       'status': 'canceled'
-    },callback);
+    }), callback);
   },
 
   pay: pingppMethod({