agora-token 2.0.3 → 2.0.5

package/src/RtmTokenBuilder2.js

@@ -1,5 +1,5 @@
-const AccessToken = require("../src/AccessToken2").AccessToken2;
-const ServiceRtm = require("../src/AccessToken2").ServiceRtm;
+const AccessToken = require('../src/AccessToken2').AccessToken2
+const ServiceRtm = require('../src/AccessToken2').ServiceRtm
 
 class RtmTokenBuilder {
     /**
@@ -11,18 +11,18 @@ class RtmTokenBuilder {
      * the Agora Dashboard. See Get an App Certificate.
      * @param userId The user's account, max length is 64 Bytes.
      * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
-     * Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
      * @return The RTM token.
      */
     static buildToken(appId, appCertificate, userId, expire) {
-        let token = new AccessToken(appId, appCertificate, null, expire);
+        let token = new AccessToken(appId, appCertificate, null, expire)
 
-        let serviceRtm = new ServiceRtm(userId);
-        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, expire);
-        token.add_service(serviceRtm);
+        let serviceRtm = new ServiceRtm(userId)
+        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, expire)
+        token.add_service(serviceRtm)
 
-        return token.build();
+        return token.build()
     }
 }
 
-module.exports.RtmTokenBuilder = RtmTokenBuilder;
+module.exports.RtmTokenBuilder = RtmTokenBuilder

package/test/AccessToken2Test.js

@@ -3,108 +3,114 @@
  * nodeunit AccessTokenTest.js
  * see https://github.com/caolan/nodeunit
  */
- const {AccessToken2, ServiceRtc, ServiceRtm, ServiceChat} = require('../src/AccessToken2')
- 
- var appID = "970CA35de60c44645bbae8a215061b33";
- var appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
- var channel = "7d72365eb983485397e3e3f9d460bdda";
- var uid = 2882341273;
- var uidStr = "2882341273"
- var ts = 1111111;
- var expire = 600;
- var salt = 1;
- var user_id = "test_user"
- 
- exports.AccessToken_Test = function (test) {
-   var expected = "007eJxTYBBbsMMnKq7p9Hf/HcIX5kce9b518kCiQgSr5Zrp4X1Tu6UUGCzNDZwdjU1TUs0Mkk1MzExMk5ISUy0SjQxNDcwMk4yN3b8IMEQwMTAwMoAwBIL4CgzmKeZGxmamqUmWFsYmFqbGluapxqnGaZYpJmYGSSkpiVwMRhYWRsYmhkbmxgDCaiTj";
- 
-   var token = new AccessToken2(appID, appCertificate, ts, expire);
-   token.salt = salt;
-   let rtc_service = new ServiceRtc(channel, uid)
-   rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
-   token.add_service(rtc_service)
- 
-   var actual = token.build();
-   test.equal(expected, actual);
-   test.done();
- };
- 
- // test uid = 0
- exports.AccessToken_Test2 = function (test) {
-  var expected = "007eJxTYLhzZP08Lxa1Pg57+TcXb/3cZ3wi4V6kbpbOog0G2dOYk20UGCzNDZwdjU1TUs0Mkk1MzExMk5ISUy0SjQxNDcwMk4yN3b8IMEQwMTAwMoAwBIL4CgzmKeZGxmamqUmWFsYmFqbGluapxqnGaZYpJmYGSSkpiQwMADacImo=";
- 
-  var token = new AccessToken2(appID, appCertificate, ts, expire);
-  token.salt = salt;
-  let rtc_service = new ServiceRtc(channel, 0)
-  rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
-  token.add_service(rtc_service)
-
-  var actual = token.build();
-  test.equal(expected, actual);
-  test.done();
- };
-
- // test service rtc account
- exports.AccessToken_Test3 = function (test) {
-  var expected = "007eJxTYBBbsMMnKq7p9Hf/HcIX5kce9b518kCiQgSr5Zrp4X1Tu6UUGCzNDZwdjU1TUs0Mkk1MzExMk5ISUy0SjQxNDcwMk4yN3b8IMEQwMTAwMoAwBIL4CgzmKeZGxmamqUmWFsYmFqbGluapxqnGaZYpJmYGSSkpiVwMRhYWRsYmhkbmxgDCaiTj";
- 
-  var token = new AccessToken2(appID, appCertificate, ts, expire);
-  token.salt = salt;
-  let rtc_service = new ServiceRtc(channel, `${uid}`)
-  rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
-  token.add_service(rtc_service)
-
-  var actual = token.build();
-  test.equal(expected, actual);
-  test.done();
- };
-
- // test service multi service
- exports.AccessToken_Test4 = function (test) {
-  var expected = "007eJxTYOAQsrQ5s3TfH+1tvy8zZZ46EpCc0V43JXdGd2jS8porKo4KDJbmBs6OxqYpqWYGySYmZiamSUmJqRaJRoamBmaGScbG7l8EGCKYGBgYGRgYmIAkCxCD+ExgkhlMsoBJBQbzFHMjYzPT1CRLC2MTC1NjS/NU41TjNMsUEzODpJSURC4GIwsLI2MTQyNzY5BZEJM4GUpSi0viS4tTiwAipyp4";
- 
-  var token = new AccessToken2(appID, appCertificate, ts, expire);
-  token.salt = salt;
-  let rtc_service = new ServiceRtc(channel, uid)
-  rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
-  rtc_service.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, expire)
-  rtc_service.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, expire)
-  rtc_service.add_privilege(ServiceRtc.kPrivilegePublishDataStream, expire)
-  token.add_service(rtc_service)
-
-  let rtm_service = new ServiceRtm(user_id)
-  rtm_service.add_privilege(ServiceRtm.kPrivilegeLogin, expire)
-  token.add_service(rtm_service)
-
-  var actual = token.build();
-  test.equal(expected, actual);
-  test.done();
- };
-
- exports.AccessToken_Test_buildChatUserToken = function (test) {
-  var expected = "007eJxTYNAIsnbS3v/A5t2TC6feR15r+6cq8bqAvfaW+tk/Vzz+p6xTYLA0N3B2NDZNSTUzSDYxMTMxTUpKTLVINDI0NTAzTDI2dv8iwBDBxMDAyADCrEDMCOZzMRhZWBgZmxgamRsDAB+lHrg="
-
-  var token = new AccessToken2(appID, appCertificate, ts, expire)
-  token.salt = salt
-  let chat_service = new ServiceChat(uidStr)
-  chat_service.add_privilege(ServiceChat.kPrivilegeUser, expire)
-  token.add_service(chat_service)
-
-  var actual = token.build()
-  test.equal(expected, actual)
-  test.done()
- }
-
- exports.AccessToken_Test_buildChatAppToken = function (test) {
-  var expected = "007eJxTYNDNaz3snC8huEfHWdz6s98qltq4zqy9fl99Uh0FDvy6F6DAYGlu4OxobJqSamaQbGJiZmKalJSYapFoZGhqYGaYZGzs/kWAIYKJgYGRAYRZgZgJzGdgAACt8hhr"
-
-  var token = new AccessToken2(appID, appCertificate, ts, expire)
-  token.salt = salt
-  let chat_service = new ServiceChat()
-  chat_service.add_privilege(ServiceChat.kPrivilegeApp, expire)
-  token.add_service(chat_service)
-
-  var actual = token.build()
-  test.equal(expected, actual)
-  test.done()
- }
+const { AccessToken2, ServiceRtc, ServiceRtm, ServiceChat } = require('../src/AccessToken2')
+
+var appID = '970CA35de60c44645bbae8a215061b33'
+var appCertificate = '5CFd2fd1755d40ecb72977518be15d3b'
+var channel = '7d72365eb983485397e3e3f9d460bdda'
+var uid = 2882341273
+var uidStr = '2882341273'
+var ts = 1111111
+var expire = 600
+var salt = 1
+var user_id = 'test_user'
+
+exports.AccessToken_Test = function (test) {
+    var expected =
+        '007eJxTYBBbsMMnKq7p9Hf/HcIX5kce9b518kCiQgSr5Zrp4X1Tu6UUGCzNDZwdjU1TUs0Mkk1MzExMk5ISUy0SjQxNDcwMk4yN3b8IMEQwMTAwMoAwBIL4CgzmKeZGxmamqUmWFsYmFqbGluapxqnGaZYpJmYGSSkpiVwMRhYWRsYmhkbmxgDCaiTj'
+
+    var token = new AccessToken2(appID, appCertificate, ts, expire)
+    token.salt = salt
+    let rtc_service = new ServiceRtc(channel, uid)
+    rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
+    token.add_service(rtc_service)
+
+    var actual = token.build()
+    test.equal(expected, actual)
+    test.done()
+}
+
+// test uid = 0
+exports.AccessToken_Test2 = function (test) {
+    var expected =
+        '007eJxTYLhzZP08Lxa1Pg57+TcXb/3cZ3wi4V6kbpbOog0G2dOYk20UGCzNDZwdjU1TUs0Mkk1MzExMk5ISUy0SjQxNDcwMk4yN3b8IMEQwMTAwMoAwBIL4CgzmKeZGxmamqUmWFsYmFqbGluapxqnGaZYpJmYGSSkpiQwMADacImo='
+
+    var token = new AccessToken2(appID, appCertificate, ts, expire)
+    token.salt = salt
+    let rtc_service = new ServiceRtc(channel, 0)
+    rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
+    token.add_service(rtc_service)
+
+    var actual = token.build()
+    test.equal(expected, actual)
+    test.done()
+}
+
+// test service rtc account
+exports.AccessToken_Test3 = function (test) {
+    var expected =
+        '007eJxTYBBbsMMnKq7p9Hf/HcIX5kce9b518kCiQgSr5Zrp4X1Tu6UUGCzNDZwdjU1TUs0Mkk1MzExMk5ISUy0SjQxNDcwMk4yN3b8IMEQwMTAwMoAwBIL4CgzmKeZGxmamqUmWFsYmFqbGluapxqnGaZYpJmYGSSkpiVwMRhYWRsYmhkbmxgDCaiTj'
+
+    var token = new AccessToken2(appID, appCertificate, ts, expire)
+    token.salt = salt
+    let rtc_service = new ServiceRtc(channel, `${uid}`)
+    rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
+    token.add_service(rtc_service)
+
+    var actual = token.build()
+    test.equal(expected, actual)
+    test.done()
+}
+
+// test service multi service
+exports.AccessToken_Test4 = function (test) {
+    var expected =
+        '007eJxTYOAQsrQ5s3TfH+1tvy8zZZ46EpCc0V43JXdGd2jS8porKo4KDJbmBs6OxqYpqWYGySYmZiamSUmJqRaJRoamBmaGScbG7l8EGCKYGBgYGRgYmBgYGVgYGMF8JjDJDCZZwKQCg3mKuZGxmWlqkqWFsYmFqbGleapxqnGaZYqJmUFSSkoiF4ORhYWRsYmhkbkxyCyISZwMJanFJfGlxalFACKnKng='
+
+    var token = new AccessToken2(appID, appCertificate, ts, expire)
+    token.salt = salt
+    let rtc_service = new ServiceRtc(channel, uid)
+    rtc_service.add_privilege(ServiceRtc.kPrivilegeJoinChannel, expire)
+    rtc_service.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, expire)
+    rtc_service.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, expire)
+    rtc_service.add_privilege(ServiceRtc.kPrivilegePublishDataStream, expire)
+    token.add_service(rtc_service)
+
+    let rtm_service = new ServiceRtm(user_id)
+    rtm_service.add_privilege(ServiceRtm.kPrivilegeLogin, expire)
+    token.add_service(rtm_service)
+
+    var actual = token.build()
+    test.equal(expected, actual)
+    test.done()
+}
+
+exports.AccessToken_Test_buildChatUserToken = function (test) {
+    var expected =
+        '007eJxTYNAIsnbS3v/A5t2TC6feR15r+6cq8bqAvfaW+tk/Vzz+p6xTYLA0N3B2NDZNSTUzSDYxMTMxTUpKTLVINDI0NTAzTDI2dv8iwBDBxMDAyADCrAyMDIxgPheDkYWFkbGJoZG5MQAfpR64'
+
+    var token = new AccessToken2(appID, appCertificate, ts, expire)
+    token.salt = salt
+    let chat_service = new ServiceChat(uidStr)
+    chat_service.add_privilege(ServiceChat.kPrivilegeUser, expire)
+    token.add_service(chat_service)
+
+    var actual = token.build()
+    test.equal(expected, actual)
+    test.done()
+}
+
+exports.AccessToken_Test_buildChatAppToken = function (test) {
+    var expected =
+        '007eJxTYNDNaz3snC8huEfHWdz6s98qltq4zqy9fl99Uh0FDvy6F6DAYGlu4OxobJqSamaQbGJiZmKalJSYapFoZGhqYGaYZGzs/kWAIYKJgYGRAYRZGRgZmMB8BgYArfIYaw=='
+
+    var token = new AccessToken2(appID, appCertificate, ts, expire)
+    token.salt = salt
+    let chat_service = new ServiceChat()
+    chat_service.add_privilege(ServiceChat.kPrivilegeApp, expire)
+    token.add_service(chat_service)
+
+    var actual = token.build()
+    test.equal(expected, actual)
+    test.done()
+}

package/test/ApaasTokenBuilderTest.js

@@ -0,0 +1,45 @@
+/**
+ * run this test with command:
+ * nodeunit test/ApaasTokenBuilderTest.js
+ * see https://github.com/caolan/nodeunit
+ */
+const ApaasTokenBuilder = require('../src/ApaasTokenBuilder').ApaasTokenBuilder
+const { AccessToken2, kApaasServiceType } = require('../src/AccessToken2')
+const appId = '970CA35de60c44645bbae8a215061b33'
+const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b'
+const expire = 600
+const roomUuid = '123'
+const userUuid = '2882341273'
+const role = 1
+
+exports.BuildRoomUserToken_Test = function (test) {
+    let accessToken = new AccessToken2('', '', 0, 0)
+    let token = ApaasTokenBuilder.buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire)
+    accessToken.from_string(token)
+    test.equal(appId, accessToken.appId)
+    test.equal(expire, accessToken.expire)
+    test.equal(roomUuid, accessToken.services[kApaasServiceType].__room_uuid)
+    test.equal(userUuid, accessToken.services[kApaasServiceType].__user_uuid)
+    test.equal(role, accessToken.services[kApaasServiceType].__role)
+    test.done()
+}
+
+exports.BuildUserToken_Test = function (test) {
+    let accessToken = new AccessToken2('', '', 0, 0)
+    let token = ApaasTokenBuilder.buildUserToken(appId, appCertificate, userUuid, expire)
+    accessToken.from_string(token)
+
+    test.equal(appId, accessToken.appId)
+    test.equal(expire, accessToken.expire)
+    test.equal(userUuid, accessToken.services[kApaasServiceType].__user_uuid)
+    test.done()
+}
+
+exports.BuildAppToken_Test = function (test) {
+    let accessToken = new AccessToken2('', '', 0, 0)
+    let token = ApaasTokenBuilder.buildAppToken(appId, appCertificate, expire)
+    accessToken.from_string(token)
+    test.equal(appId, accessToken.appId)
+    test.equal(expire, accessToken.expire)
+    test.done()
+}

package/test/EducationTokenBuilderTest.js

@@ -3,43 +3,43 @@
  * nodeunit test/EducationTokenBuilderTest.js
  * see https://github.com/caolan/nodeunit
  */
-const EduTokenBuilder = require('../src/EducationTokenBuilder').EducationTokenBuilder
-const {AccessToken2, kEducationServiceType} = require('../src/AccessToken2')
-const appId = "970CA35de60c44645bbae8a215061b33"
-const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b"
+const EducationTokenBuilder = require('../src/EducationTokenBuilder').EducationTokenBuilder
+const { AccessToken2, kApaasServiceType } = require('../src/AccessToken2')
+const appId = '970CA35de60c44645bbae8a215061b33'
+const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b'
 const expire = 600
-const roomUuid = "123";
-const userUuid = "2882341273";
-const role = 1;
+const roomUuid = '123'
+const userUuid = '2882341273'
+const role = 1
 
- exports.BuildRoomUserToken_Test = function (test) {
-   let accessToken = new AccessToken2('', '', 0, 0)
-   let token = EduTokenBuilder.buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire)
-   accessToken.from_string(token)
-   test.equal(appId, accessToken.appId)
+exports.BuildRoomUserToken_Test = function (test) {
+    let accessToken = new AccessToken2('', '', 0, 0)
+    let token = EducationTokenBuilder.buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire)
+    accessToken.from_string(token)
+    test.equal(appId, accessToken.appId)
     test.equal(expire, accessToken.expire)
-   test.equal(roomUuid, accessToken.services[kEducationServiceType].__room_uuid)
-   test.equal(userUuid, accessToken.services[kEducationServiceType].__user_uuid)
-   test.equal(role, accessToken.services[kEducationServiceType].__role)
-   test.done()
+    test.equal(roomUuid, accessToken.services[kApaasServiceType].__room_uuid)
+    test.equal(userUuid, accessToken.services[kApaasServiceType].__user_uuid)
+    test.equal(role, accessToken.services[kApaasServiceType].__role)
+    test.done()
 }
- 
- exports.BuildUserToken_Test = function (test) {
-   let accessToken = new AccessToken2('', '', 0, 0)
-   let token = EduTokenBuilder.buildUserToken(appId, appCertificate, userUuid, expire)
-   accessToken.from_string(token)
 
-   test.equal(appId, accessToken.appId)
-   test.equal(expire, accessToken.expire)
-   test.equal(userUuid, accessToken.services[kEducationServiceType].__user_uuid)
-   test.done()
- }
- 
- exports.BuildAppToken_Test = function (test) {
-   let accessToken = new AccessToken2('', '', 0, 0)
-   let token = EduTokenBuilder.buildAppToken(appId, appCertificate, expire)
-   accessToken.from_string(token)
-   test.equal(appId, accessToken.appId)
-   test.equal(expire, accessToken.expire)
-   test.done()
- }
+exports.BuildUserToken_Test = function (test) {
+    let accessToken = new AccessToken2('', '', 0, 0)
+    let token = EducationTokenBuilder.buildUserToken(appId, appCertificate, userUuid, expire)
+    accessToken.from_string(token)
+
+    test.equal(appId, accessToken.appId)
+    test.equal(expire, accessToken.expire)
+    test.equal(userUuid, accessToken.services[kApaasServiceType].__user_uuid)
+    test.done()
+}
+
+exports.BuildAppToken_Test = function (test) {
+    let accessToken = new AccessToken2('', '', 0, 0)
+    let token = EducationTokenBuilder.buildAppToken(appId, appCertificate, expire)
+    accessToken.from_string(token)
+    test.equal(appId, accessToken.appId)
+    test.equal(expire, accessToken.expire)
+    test.done()
+}