Skip to content

Commit 8ba644e

Browse files
leeyehleeyeh
committed
feat: captcha (#469)
1 parent 12b47a7 commit 8ba644e

File tree

8 files changed

+137
-95
lines changed

8 files changed

+137
-95
lines changed

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ coverage
66
*.swp
77
dist/js-sdk-api-docs
88
npm-debug.log
9-
demo/test-es5.js
109
.nyc_output
1110
dist
1211
docs

‎README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,6 @@ bower install leancloud-storage --save
3939
* `fork` 这个项目
4040
* `npm install` 安装相关依赖
4141
* 开发和调试
42-
* 浏览器环境执行 `gulp dev`，会自动启动 `demo` 目录，可在 `test-es6.js` 中修改和测试，`test-es5.js` 为自动生成的代码
43-
* Nodejs 环境同样在 `demo` 目录中，通过执行 `node test-es6.js` 开发与调试。推荐安装 `node inspector` 来调试，安装后执行 `node-debug test-es6.js`。每次修改代码后，如果开发代码引用的是 dist 目录中的代码，需要执行 `gulp release`
4442
* 确保测试全部通过 `npm run test`，浏览器环境打开 `test/test.html`
4543
* 提交并发起 `Pull Request`
4644

‎demo/index.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@ <h1><a href="https://leancloud.cn">LeanCloud</a></h1>
1010
<h2><a href="https://leancloud.cn">为开发加速</a></h2>
1111
<div class="tips">
1212
<p>欢迎调试 JavaScript SDK，请打开浏览器控制台</p>
13+
<img id='captcha' onclick="refreshCaptcha()"/>
14+
<input type="text" id='code'/>
15+
<button onclick="verify()">verify</button>
1316
</div>
1417
<script src="../dist/av.js"></script>
15-
<script src="./test-es5.js"></script>
18+
<script src="./test.js"></script>
1619
</body>
1720
</html>

‎demo/test-es6.js‎

Lines changed: 0 additions & 66 deletions
This file was deleted.

‎demo/test.js‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
var av = void 0;
2+
3+
// 检测是否在 Nodejs 环境下运行
4+
if (typeof process !== 'undefined' && process.versions && process.versions.node) {
5+
av = require('../dist/node/av');
6+
} else {
7+
av = window.AV;
8+
}
9+
10+
// 初始化
11+
var appId = 'a5CDnmOX94uSth8foK9mjHfq-gzGzoHsz';
12+
var appKey = 'Ue3h6la9zH0IxkUJmyhLjk9h';
13+
var region = 'cn';
14+
15+
// const appId = 'QvNM6AG2khJtBQo6WRMWqfLV-gzGzoHsz';
16+
// const appKey = 'be2YmUduiuEnCB2VR9bLRnnV';
17+
// const region = 'us';
18+
19+
av.init({ appId: appId, appKey: appKey, region: region });
20+
21+
let captchaToken;
22+
const captchaImage = document.getElementById('captcha');
23+
const captchaInput = document.getElementById('code');
24+
25+
function refreshCaptcha(){
26+
AV.Cloud.requestCaptcha({
27+
size: 6,
28+
ttl: 30,
29+
}).then(function(data) {
30+
captchaToken = data.captchaToken;
31+
captchaImage.src = data.url;
32+
}).catch(console.error);
33+
}
34+
refreshCaptcha();
35+
36+
function verify() {
37+
AV.Cloud.verifyCaptcha(captchaInput.value, captchaToken).then(function(validateCode) {
38+
console.log('validateCode: ' + validateCode);
39+
}, console.error);
40+
}

‎src/cloudfunction.js‎

Lines changed: 48 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,29 @@ module.exports = function(AV) {
7171

7272
/**
7373
* Makes a call to request a sms code for operation verification.
74-
* @param {Object} data The mobile phone number string or a JSON
75-
* object that contains mobilePhoneNumber,template,op,ttl,name etc.
76-
* @return {Promise} A promise that will be resolved with the result
77-
* of the function.
74+
* @param {String|Object} data The mobile phone number string or a JSON
75+
* object that contains mobilePhoneNumber,template,sign,op,ttl,name etc.
76+
* @param {String} data.mobilePhoneNumber
77+
* @param {String} [data.template] sms template name
78+
* @param {String} [data.sign] sms signature name
79+
* @param {AuthOptions} [options] AuthOptions plus:
80+
* @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
81+
* @return {Promise} A promise that will be resolved if the request succeed
7882
*/
79-
requestSmsCode(data) {
83+
requestSmsCode(data, options = {}) {
8084
if(_.isString(data)) {
8185
data = { mobilePhoneNumber: data };
8286
}
8387
if(!data.mobilePhoneNumber) {
8488
throw new Error('Missing mobilePhoneNumber.');
8589
}
90+
if (options.validateToken) {
91+
data = _.extend({}, data, {
92+
validate_token: options.validateToken,
93+
});
94+
}
8695
return _request("requestSmsCode", null, null, 'POST',
87-
data);
96+
data, options);
8897
},
8998

9099
/**
@@ -104,6 +113,38 @@ module.exports = function(AV) {
104113

105114
return _request("verifySmsCode", code, null, 'POST',
106115
params);
107-
}
116+
},
117+
118+
/**
119+
* request a captcha
120+
* @param {Object} [options]
121+
* @param {Number} [options.size=4] length of the captcha, ranged 3-6
122+
* @param {Number} [options.width] width(px) of the captcha, ranged 60-200
123+
* @param {Number} [options.height] height(px) of the captcha, ranged 30-100
124+
* @param {Number} [options.ttl=60] time to live(s), ranged 10-180
125+
* @return {Promise} { captchaToken, url }
126+
*/
127+
requestCaptcha(options) {
128+
return _request('requestCaptcha', null, null, 'GET', options).then(({
129+
captcha_url: url,
130+
captcha_token: captchaToken,
131+
}) => ({
132+
captchaToken,
133+
url,
134+
}));
135+
},
136+
137+
/**
138+
* verify captcha code
139+
* @param {String} code the code from user input
140+
* @param {String} captchaToken captchaToken returned by {@link AV.Cloud.requestCaptcha}
141+
* @return {Promise.<String>} validateToken if the code is valid
142+
*/
143+
verifyCaptcha(code, captchaToken) {
144+
return _request('verifyCaptcha', null, null, 'POST', {
145+
captcha_code: code,
146+
captcha_token: captchaToken,
147+
}).then(({ validate_token: validateToken }) => validateToken);
148+
},
108149
});
109150
};

‎src/user.js‎

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -899,14 +899,21 @@ module.exports = function(AV) {
899899
* number associated with the user account. This sms code allows the user to
900900
* verify their mobile phone number by calling AV.User.verifyMobilePhone
901901
*
902-
* @param {String} mobilePhone The mobile phone number associated with the
902+
* @param {String} mobilePhoneNumber The mobile phone number associated with the
903903
* user that doesn't verify their mobile phone number.
904+
* @param {AuthOptions} [options] AuthOptions plus:
905+
* @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
904906
* @return {Promise}
905907
*/
906-
requestMobilePhoneVerify: function(mobilePhone){
907-
var json = { mobilePhoneNumber: mobilePhone };
908+
requestMobilePhoneVerify: function(mobilePhoneNumber, options = {}){
909+
const data = {
910+
mobilePhoneNumber,
911+
}
912+
if (options.validataToken) {
913+
data.validate_token = options.validataToken
914+
}
908915
var request = AVRequest("requestMobilePhoneVerify", null, null, "POST",
909-
json);
916+
data, options);
910917
return request;
911918
},
912919

@@ -916,14 +923,21 @@ module.exports = function(AV) {
916923
* number associated with the user account. This sms code allows the user to
917924
* reset their account's password by calling AV.User.resetPasswordBySmsCode
918925
*
919-
* @param {String} mobilePhone The mobile phone number associated with the
926+
* @param {String} mobilePhoneNumber The mobile phone number associated with the
920927
* user that doesn't verify their mobile phone number.
928+
* @param {AuthOptions} [options] AuthOptions plus:
929+
* @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
921930
* @return {Promise}
922931
*/
923-
requestPasswordResetBySmsCode: function(mobilePhone){
924-
var json = { mobilePhoneNumber: mobilePhone };
932+
requestPasswordResetBySmsCode: function(mobilePhoneNumber, options = {}){
933+
const data = {
934+
mobilePhoneNumber,
935+
}
936+
if (options.validataToken) {
937+
data.validate_token = options.validataToken
938+
}
925939
var request = AVRequest("requestPasswordResetBySmsCode", null, null, "POST",
926-
json);
940+
data, options);
927941
return request;
928942
},
929943

@@ -960,14 +974,21 @@ module.exports = function(AV) {
960974
* number associated with the user account. This sms code allows the user to
961975
* login by AV.User.logInWithMobilePhoneSmsCode function.
962976
*
963-
* @param {String} mobilePhone The mobile phone number associated with the
977+
* @param {String} mobilePhoneNumber The mobile phone number associated with the
964978
* user that want to login by AV.User.logInWithMobilePhoneSmsCode
979+
* @param {AuthOptions} [options] AuthOptions plus:
980+
* @param {String} [options.validateToken] a validate token returned by {@link AV.Cloud.verifyCaptcha}
965981
* @return {Promise}
966982
*/
967-
requestLoginSmsCode: function(mobilePhone){
968-
var json = { mobilePhoneNumber: mobilePhone };
983+
requestLoginSmsCode: function(mobilePhoneNumber, options = {}){
984+
const data = {
985+
mobilePhoneNumber,
986+
}
987+
if (options.validataToken) {
988+
data.validate_token = options.validataToken
989+
}
969990
var request = AVRequest("requestLoginSmsCode", null, null, "POST",
970-
json);
991+
data, options);
971992
return request;
972993
},
973994

‎storage.d.ts‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ declare namespace AV {
1717
user?: User;
1818
}
1919

20+
interface SMSAuthOptions extends AuthOptions {
21+
validateToken?: string;
22+
}
23+
2024
export interface WaitOption {
2125
/**
2226
* Set to true to wait for the server to confirm success
@@ -509,10 +513,10 @@ declare namespace AV {
509513
static signUpOrlogInWithAuthData<T>(data: any, platform: string, options?: AuthOptions): Promise<T>;
510514
static signUpOrlogInWithMobilePhone<T>(mobilePhoneNumber: string, smsCode: string, attributes?: any, options?: AuthOptions): Promise<T>;
511515
static requestEmailVerify<T>(email: string, options?: AuthOptions): Promise<T>;
512-
static requestLoginSmsCode<T>(mobilePhone: string, options?: AuthOptions): Promise<T>;
513-
static requestMobilePhoneVerify<T>(mobilePhone: string, options?: AuthOptions): Promise<T>;
516+
static requestLoginSmsCode(mobilePhoneNumber: string, options?: SMSAuthOptions): Promise<void>;
517+
static requestMobilePhoneVerify(mobilePhoneNumber: string, options?: SMSAuthOptions): Promise<void>;
514518
static requestPasswordReset<T>(email: string, options?: AuthOptions): Promise<T>;
515-
static requestPasswordResetBySmsCode<T>(mobilePhone: string, options?: AuthOptions): Promise<T>;
519+
static requestPasswordResetBySmsCode(mobilePhoneNumber: string, options?: SMSAuthOptions): Promise<void>;
516520
static resetPasswordBySmsCode<T>(code: string, password: string, options?: AuthOptions): Promise<T>;
517521
static verifyMobilePhone<T>(code: string, options?: AuthOptions): Promise<T>;
518522
signUp<T>(attrs?: any, options?: AuthOptions): Promise<T>;
@@ -674,9 +678,11 @@ declare namespace AV {
674678
}
675679

676680
export namespace Cloud {
677-
function run<T>(name: string, data?: any, options?: AuthOptions): Promise<T>;
678-
function requestSmsCode<T>(data: any, options?: AuthOptions): Promise<T>;
679-
function verifySmsCode<T>(code: string, phone: string, options?: AuthOptions): Promise<T>;
681+
function run(name: string, data?: any, options?: AuthOptions): Promise<any>;
682+
function requestSmsCode(data: string|{ mobilePhoneNumber: string, template?: string, sign?: string }, options?: SMSAuthOptions): Promise<void>;
683+
function verifySmsCode(code: string, phone: string): Promise<void>;
684+
function requestCaptcha(options?: { size?: number, width?: number, height?: number, ttl?: number}): Promise<{ captchaToken: string, dataURI: string }>;
685+
function verifyCaptcha(code: string, captchaToken: string): Promise<void>;
680686
}
681687

682688
interface ServerURLs {

0 commit comments

Comments
 (0)