增加 AV._config.userAgent，补充 node demo 目录。 (#273)

* Clean code

修改 NPM 中 SDK 名字

修正 bower 发布名。

启用 ESlint，基于 Airbnb 编码规范

补充 Nodejs 开发目录

Supplementary README.md

Add ESlint rules setting

Do not compile demo/node directory

Perfect the documents

Replace AV._ajax to Requset in test case

Deprecate AV._ajax

Change UA by AV._config.userAgent

Do not use new package name

* Browser unit test import  superagent.

* Remove debug from devDependence.

* Fixed some copywriting.

* fixed av.file unit test in node 0.12.14.

* fixed av.file unit test in node 0.12.14.

Author: wangxiao

.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  extends: 'airbnb',
+  rules: {
+    'no-param-reassign': 0,
+    'no-underscore-dangle': 0
+  }
+};

.jshintrc

@@ -11,28 +11,30 @@ JavaScript SDK for [LeanCloud](http://leancloud.cn/).
 
 可以使用以下命令安装 1.0.0-x 版本：`npm install avoscloud-sdk@next`。
 
-## 贡献
+## 贡献代码
 
-* fork 这个项目
+* `fork` 这个项目
 * `npm install` 安装相关依赖
-* 浏览器环境执行 `gulp dev`，会自动启动 demo 目录，可在 test-es6.js 中修改和测试，test-es5.js 为自动生成的代码
-* 确保测试全部通过 `gulp test`，浏览器环境打开 test/test.html
-* 提交并发起 Pull Request
+* 开发和调试
+  * 浏览器环境执行 `gulp dev`，会自动启动 `demo` 目录，可在 `test-es6.js` 中修改和测试，`test-es5.js` 为自动生成的代码
+  * Nodejs 环境可以在 `demo/node` 目录中，通过执行 `node test.js` 使用 `test.js` 文件开发与调试。推荐安装 `node inspector` 来调试，安装后执行 `node-debug test.js`。每次修改代码后，如果开发代码引用的是 dist 目录中的代码，需要执行 `gulp release`
+* 确保测试全部通过 `gulp test`，浏览器环境打开 `test/test.html`
+* 提交并发起 `Pull Request`
 * 执行 `gulp release` 会生成全部版本的 SDK
 
 项目的目录结构说明如下：
 
 ```
 ├── README.md                          // 说明文档
-├── bower.json
+├── demo                               // demo 目录中有一些代码片段，主要用于开发与调试
 ├── changelog.md
 ├── dist                               // 编译之后生成的文件将会在此目录下
 │   ├── av-es6.js                      // 合并后的完整源码（ES6 版本）
 │   ├── av.js                          // 合并并编译后的完整源码（ES5 版本）
 │   ├── av-min.js                      // 合并、压缩并编译后的源码（ES5 版本）
 │   ├── node                           // 目录中为生成的 nodejs 版本代码
 │   └── ...
-├── gulpfile.js
+├── gulpfile.babel.js
 ├── src
 │   ├── av.js                          // node.js 环境入口文件
 │   ├── browserify-wrapper             // 目录中为针对 node.js 与浏览器环境之间差异的不同实现

README.md

@@ -3,7 +3,7 @@
   "version": "1.0.0-rc9.1",
   "homepage": "https://github.com/leancloud/javascript-sdk",
   "authors": [
-    "killme2008 <xzhuang@leancloud.rocks>"
+    "LeanCloud <support@leancloud.rocks>"
   ],
   "description": "LeanCloud JavaScript SDK",
   "main": "dist/av.js",

bower.json

@@ -0,0 +1,41 @@
+// Nodejs 4.x 版本已经支持 EcmaScript2015 (ES6)
+
+const AV = require('../../dist/node/av');
+
+// 初始化
+const appId = 'a5CDnmOX94uSth8foK9mjHfq-gzGzoHsz';
+const appKey = 'Ue3h6la9zH0IxkUJmyhLjk9h';
+
+AV.init({ appId, appKey });
+
+// 基本存储
+const TestClass = AV.Object.extend('TestClass');
+const testObj = new TestClass();
+testObj.set({
+  name: 'hjiang',
+  phone: '123123123',
+});
+
+testObj.save().then(() => {
+  console.log('success');
+}).catch((err) => {
+  console.log('failed');
+  console.log(err);
+});
+
+// 存储文件
+const base64 = 'd29ya2luZyBhdCBhdm9zY2xvdWQgaXMgZ3JlYXQh';
+const file = new AV.File('myfile.txt', { base64 });
+file.metaData('format', 'txt file');
+file.save().then(() => {
+  console.log('success');
+}).catch((error) => {
+  console.log(error);
+});
+
+// 查找文件
+const query = new AV.Query(TestClass);
+query.equalTo('name', 'hjiang');
+query.find().then(() => {
+  console.log('success');
+});

demo/node/test.js

@@ -3,10 +3,7 @@
 // 初始化
 var appId = 'a5CDnmOX94uSth8foK9mjHfq-gzGzoHsz';
 var appKey = 'Ue3h6la9zH0IxkUJmyhLjk9h';
-AV.init({
-  appId: appId,
-  appKey: appKey
-});
+AV.init({ appId: appId, appKey: appKey });
 
 // 基本存储
 var TestClass = AV.Object.extend('TestClass');

demo/test-es5.js

@@ -1,10 +1,7 @@
 // 初始化
 const appId = 'a5CDnmOX94uSth8foK9mjHfq-gzGzoHsz';
 const appKey = 'Ue3h6la9zH0IxkUJmyhLjk9h';
-AV.init({
-  appId: appId,
-  appKey: appKey
-});
+AV.init({ appId, appKey });
 
 // 基本存储
 const TestClass = AV.Object.extend('TestClass');
@@ -38,4 +35,3 @@ query.find().then((list) => {
   console.log(list);
 });
 
-

demo/test-es6.js

@@ -144,7 +144,7 @@ gulp.task('clean-demo', () => {
 
 // 编译 Demo 中的代码
 gulp.task('babel-demo', ['clean-demo'], () => {
-  return gulp.src('demo/**/*.js')
+  return gulp.src('demo/*.js')
     // .pipe(sourcemaps.init())
     .pipe(babel())
     .pipe(concat('test-es5.js'))

gulpfile.babel.js

@@ -23,6 +23,11 @@
     "babel-preset-es2015": "^6.3.13",
     "browser-sync": "^2.2.1",
     "browserify": "^11.0.1",
+    "eslint": "^2.8.0",
+    "eslint-config-airbnb": "^8.0.0",
+    "eslint-plugin-import": "^1.6.0",
+    "eslint-plugin-jsx-a11y": "^1.0.3",
+    "eslint-plugin-react": "^5.0.1",
     "expect.js": "0.2.0",
     "gulp": "^3.8.10",
     "gulp-babel": "^6.1.1",

package.json

@@ -3,13 +3,10 @@
  * Each engineer has a duty to keep the code elegant
 **/
 
-'use strict';
-
 const _ = require('underscore');
 const ajax = require('./ajax');
 const Cache = require('./cache');
 const md5 = require('md5');
-const debug = require('debug')('utils');
 
 // 计算 X-LC-Sign 的签名方法
 const sign = (key, isMasterKey) => {
@@ -30,7 +27,7 @@ const init = (AV) => {
   // 服务器请求的节点 host
   const API_HOST = {
     cn: 'https://api.leancloud.cn',
-    us: 'https://us-api.leancloud.cn'
+    us: 'https://us-api.leancloud.cn',
   };
 
   _.extend(AVConfig, {
@@ -45,7 +42,10 @@ const init = (AV) => {
     isNode: false,
 
     // 禁用 currentUser，通常用于多用户环境
-    disableCurrentUser: false
+    disableCurrentUser: false,
+
+    // Internal config can modifie the UserAgent
+    userAgent: null,
   });
 
   /**
@@ -338,7 +338,10 @@ const init = (AV) => {
     return new Date(Date.UTC(year, month, day, hour, minute, second, milli));
   };
 
-  AV._ajax = ajax;
+  AV._ajax = (...args) => {
+    console.warn('AV._ajax is deprecated, and will be removed in next release.');
+    ajax(...args);
+  };
 
   // A self-propagating extend function.
   AV._extend = function(protoProps, classProps) {
@@ -470,7 +473,7 @@ const init = (AV) => {
         }
       }
 
-      return AV._ajax(method, apiURL, dataObject, headers).then(null, function(response) {
+      return ajax(method, apiURL, dataObject, headers).then(null, function(response) {
         // Transform the error into an instance of AV.Error by trying to parse
         // the error string as JSON.
         var error;
@@ -747,4 +750,4 @@ const init = (AV) => {
 module.exports = {
 
   init: init
-};
+};