Merge pull request #102 from qiniu/develop

Release 6.1.3

Author: longbai

CHANGELOG.md

@@ -1,5 +1,12 @@
 ## CHANGE LOG
 
+### v6.1.3
+
+2014-4-03 issue [#102](https://github.com/qiniu/nodejs-sdk/pull/102)
+
+- [#98] 增加pfop 功能
+- [#99] 增加针对七牛callback的检查
+
 ### v6.1.2
 
 2014-2-17 issue [#96](https://github.com/qiniu/nodejs-sdk/pull/96)

docs/README.gist.md

@@ -333,6 +333,19 @@ PutExtra是上传时的可选信息，默认为null
 ### 云处理
 
 <a云处理使用说明\>
+
+#### pfop
+`pfop`的作用是对已存在七牛服务器上的文件做持久化的fop，具体见[api文档](http://developer.qiniu.com/docs/v6/api/overview/fop/persistent-fop.html)
+
+```{javascript}
+// 原型
+func pfop(bucketName, keyName, fops, opts, callback);
+
+// 例子
+@gist(../test/io.test.js#pfop)
+
+```
+
 #### 查看图像信息
 
 ```{javascript}
@@ -351,6 +364,15 @@ PutExtra是上传时的可选信息，默认为null
 @gist(gist/fop.js#makeImageViewUrl)
 ```
 
+### 实用函数
+
+#### 测试是否来自七牛的callback
+在上传的`putPolicy`中指定`callbackUrl`和`callbackBody`，在上传成功后七牛会有一个回调函数，这个函数用来检测回调是否来自七牛。  
+
+```{javascript}
+@gist(../test/rs.test.js#isQiniuCallback)
+```
+
 ## 贡献代码
 
 + Fork

docs/README.md

@@ -174,7 +174,8 @@ function uptoken(bucketname) {
   //putPolicy.callbackBody = callbackBody;
   //putPolicy.returnUrl = returnUrl;
   //putPolicy.returnBody = returnBody;
-  //putPolicy.asyncOps = asyncOps;
+  //putpolicy.persistentOps = persistentops;
+  //putPolicy.persistentNotifyUrl = persistentNotifyUrl;
   //putPolicy.expires = expires;
 
   return putPolicy.token();
@@ -529,6 +530,23 @@ qiniu.rsf.listPrefix(bucketname, prefix, marker, limit, function(err, ret) {
 ### 云处理
 
 <a云处理使用说明\>
+
+#### pfop
+`pfop`的作用是对已存在七牛服务器上的文件做持久化的fop，具体见[api文档](http://developer.qiniu.com/docs/v6/api/overview/fop/persistent-fop.html)
+
+```{javascript}
+// 原型
+func pfop(bucketName, keyName, fops, opts, callback);
+
+// 例子
+// pfop
+      qiniu.fop.pfop(TEST_BUCKET, keys[0], 'avinfo', {notifyUrl: 'www.test.com', force: true}, function(err, ret) {
+        ret.should.have.keys('persistentId');
+        done();
+      });
+
+```
+
 #### 查看图像信息
 
 ```{javascript}
@@ -584,6 +602,22 @@ url = policy.makeRequest(url);
 console.log('在浏览器输入: ' + url);
 ```
 
+### 实用函数
+
+#### 测试是否来自七牛的callback
+在上传的`putPolicy`中指定`callbackUrl`和`callbackBody`，在上传成功后七牛会有一个回调函数，这个函数用来检测回调是否来自七牛。  
+
+```{javascript}
+// ------ auth应该是来自请求的header的'Authrization'字段，path是请求的路径，content是请求的内容
+        var auth = 'QBox nnwjTeUgpQdfZp9cb4-iHK0EUlebKCNk4kXwoStq:kyFuG6yYh6FlX1fZO0alTgJK2Jw=';
+        var path = '/callback';
+        var content = 'key=43850.6579994258936495&hash=FllOJrhvzorEKnyMwE-o7pfciiha';
+// ------
+
+        var ok = qiniu.util.isQiniuCallback(path, content, auth);
+        ok.should.be.ok;
+```
+
 ## 贡献代码
 
 + Fork

index.js

@@ -7,4 +7,6 @@ module.exports = {
   rsf: require(libpath + '/rsf.js'),
   fop: require(libpath + '/fop.js'),
   conf: require(libpath + '/conf.js'),
+  rpc: require(libpath + '/rpc.js'),
+  util: require(libpath + '/util.js')
 };

qiniu/fop.js

@@ -1,8 +1,12 @@
+var util = require('./util');
+var rpc = require('./rpc');
 
+var querystring = require('querystring');
 
 exports.ImageView = ImageView;
 exports.ImageInfo = ImageInfo;
 exports.Exif = Exif;
+exports.pfop = pfop;
 
 function ImageView(mode, width, height, quality, format) {
   this.mode = mode || 1;
@@ -49,3 +53,27 @@ Exif.prototype.makeRequest = function(url) {
 }
 
 
+function pfop(bucket, key, fops, opts, onret) {
+
+  opts = opts || {};
+
+  param = {
+    bucket: bucket,
+    key: key,
+    fops: fops
+  };
+  if (opts.notifyURL) {
+    param.notifyURL = opts.notifyURL;
+  } else {
+    param.notifyURL = 'www.test.com';
+  }
+  if (opts.force) {
+    param.force = 1;
+  }
+
+  var uri = 'http://api.qiniu.com/pfop/';
+  var body = querystring.stringify(param);
+  var auth = util.generateAccessToken(uri, body);
+  rpc.postWithForm(uri, body, auth, onret);
+}
+

qiniu/rs.js

@@ -183,6 +183,12 @@ PutPolicy.prototype.getFlags = function(putPolicy) {
   if (this.endUser != null) {
     flags['endUser'] = this.endUser;
   }
+  if (this.persistentOps != null) {
+    flags['persistentOps'] = this.persistentOps;
+  }
+  if (this.persistentNotifyUrl != null) {
+    flags['persistentNotifyUrl'] = this.persistentNotifyUrl;
+  }
   flags['deadline'] = this.expires + Math.floor(Date.now() / 1000);
   return flags;
 }

qiniu/util.js

@@ -4,6 +4,8 @@ var path = require('path');
 var crypto = require('crypto');
 var conf = require('./conf');
 
+exports.isQiniuCallback = isQiniuCallback;
+
 // ------------------------------------------------------------------------------------------
 // func encode
 
@@ -41,3 +43,9 @@ exports.generateAccessToken = function(uri, body) {
   var safeDigest = exports.base64ToUrlSafe(digest);
   return 'QBox ' + conf.ACCESS_KEY + ':' + safeDigest;
 }
+
+function isQiniuCallback(path, body, callbackAuth) {
+
+  var auth = exports.generateAccessToken(path, body)
+  return auth === callbackAuth;
+}

test/io.test.js

@@ -133,4 +133,16 @@ describe('test start step1:', function() {
       });
     });
   });
+
+  describe('pfop', function() {
+    it('do pfop', function(done) {
+// @gist pfop
+// pfop
+      qiniu.fop.pfop(TEST_BUCKET, keys[0], 'avinfo', {notifyURL: 'www.test.com'}, function(err, ret) {
+        ret.should.have.keys('persistentId');
+        done();
+      });
+// @endgist
+    })
+  });
 });

test/rs.test.js

@@ -164,6 +164,25 @@ describe('test start step2:', function() {
       });
     });
 
+    describe('rs.isQiniuCallBack', function() {
+
+      it('test isQiniuCallback true', function(done) {
+// @gist isQiniuCallback
+// ------ auth应该是来自请求的header的'Authrization'字段，path是请求的路径，content是请求的内容
+        var auth = 'QBox nnwjTeUgpQdfZp9cb4-iHK0EUlebKCNk4kXwoStq:kyFuG6yYh6FlX1fZO0alTgJK2Jw=';
+        var path = '/callback';
+        var content = 'key=43850.6579994258936495&hash=FllOJrhvzorEKnyMwE-o7pfciiha';
+// ------
+
+        var ok = qiniu.util.isQiniuCallback(path, content, auth);
+        ok.should.be.ok;
+// @endgist
+        done();
+      });
+
+
+    });
+
     // rs.GetPolicy#makeRequest()
 
   });