Merge pull request #68 from TaleLin/shirmy-patch-2

feat: change 'permission' for 'auth'

Author: smileShirmy

README.md

@@ -35,9 +35,9 @@ Lin-CMS 是林间有风团队经过大量项目实践所提炼出的一套**内
 
 ### 当前最新版本
 
-lin-mizar(核心库) ：0.3.1
+lin-mizar(核心库) ：0.3.2
 
-lin-cms-koa(当前示例工程)：0.3.0
+lin-cms-koa(当前示例工程)：0.3.1
 
 ### 文档地址
 
@@ -61,13 +61,16 @@ QQ 群号：643205479
 
 ## 版本日志
 
-最新版本 `0.3.0`
+最新版本 `0.3.1`
+
+### 0.3.1
+
+1. `F` 更新 `lin-mizar` 到 `0.3.2` 版本，路由属性名由 `auth` --> `permission`
 
 ### 0.3.0
 
 1. `A` 将模型层抽离核心库进行重构
 
-
 ## Lin CMS 的特点
 
 Lin CMS 的构筑思想是有其自身特点的。下面我们阐述一些 Lin 的主要特点。

app/api/cms/admin.js

@@ -27,7 +27,7 @@ admin.linGet(
   'getAllPermissions',
   '/permission',
   {
-    auth: '查询所有可分配的权限',
+    permission: '查询所有可分配的权限',
     module: '管理员',
     mount: false
   },
@@ -42,7 +42,7 @@ admin.linGet(
   'getAdminUsers',
   '/users',
   {
-    auth: '查询所有用户',
+    permission: '查询所有用户',
     module: '管理员',
     mount: false
   },
@@ -67,7 +67,7 @@ admin.linPut(
   'changeUserPassword',
   '/user/:id/password',
   {
-    auth: '修改用户密码',
+    permission: '修改用户密码',
     module: '管理员',
     mount: false
   },
@@ -86,7 +86,7 @@ admin.linDelete(
   'deleteUser',
   '/user/:id',
   {
-    auth: '删除用户',
+    permission: '删除用户',
     module: '管理员',
     mount: false
   },
@@ -106,7 +106,7 @@ admin.linPut(
   'updateUser',
   '/user/:id',
   {
-    auth: '管理员更新用户信息',
+    permission: '管理员更新用户信息',
     module: '管理员',
     mount: false
   },
@@ -125,7 +125,7 @@ admin.linGet(
   'getAdminGroups',
   '/group',
   {
-    auth: '查询所有权限组及其权限',
+    permission: '查询所有权限组及其权限',
     module: '管理员',
     mount: false
   },
@@ -155,7 +155,7 @@ admin.linGet(
   'getAllGroup',
   '/group/all',
   {
-    auth: '查询所有权限组',
+    permission: '查询所有权限组',
     module: '管理员',
     mount: false
   },
@@ -175,7 +175,7 @@ admin.linGet(
   'getGroup',
   '/group/:id',
   {
-    auth: '查询一个权限组及其权限',
+    permission: '查询一个权限组及其权限',
     module: '管理员',
     mount: false
   },
@@ -191,7 +191,7 @@ admin.linPost(
   'createGroup',
   '/group',
   {
-    auth: '新建权限组',
+    permission: '新建权限组',
     module: '管理员',
     mount: false
   },
@@ -215,7 +215,7 @@ admin.linPut(
   'updateGroup',
   '/group/:id',
   {
-    auth: '更新一个权限组',
+    permission: '更新一个权限组',
     module: '管理员',
     mount: false
   },
@@ -234,7 +234,7 @@ admin.linDelete(
   'deleteGroup',
   '/group/:id',
   {
-    auth: '删除一个权限组',
+    permission: '删除一个权限组',
     module: '管理员',
     mount: false
   },
@@ -254,7 +254,7 @@ admin.linPost(
   'dispatchPermission',
   '/permission/dispatch',
   {
-    auth: '分配单个权限',
+    permission: '分配单个权限',
     module: '管理员',
     mount: false
   },
@@ -273,7 +273,7 @@ admin.linPost(
   'dispatchPermissions',
   '/permission/dispatch/batch',
   {
-    auth: '分配多个权限',
+    permission: '分配多个权限',
     module: '管理员',
     mount: false
   },
@@ -292,7 +292,7 @@ admin.linPost(
   'removePermissions',
   '/permission/remove',
   {
-    auth: '删除多个权限',
+    permission: '删除多个权限',
     module: '管理员',
     mount: false
   },

app/api/cms/log.js

@@ -15,7 +15,7 @@ log.linGet(
   'getLogs',
   '/',
   {
-    auth: '查询所有日志',
+    permission: '查询所有日志',
     module: '日志',
     mount: true
   },
@@ -41,7 +41,7 @@ log.linGet(
   'getUserLogs',
   '/search',
   {
-    auth: '搜索日志',
+    permission: '搜索日志',
     module: '日志',
     mount: true
   },
@@ -63,7 +63,7 @@ log.linGet(
   'getUsers',
   '/users',
   {
-    auth: '查询日志记录的用户',
+    permission: '查询日志记录的用户',
     module: '日志',
     mount: true
   },

app/api/cms/test.js

@@ -19,7 +19,7 @@ test.linGet(
   'getTestMsg',
   '/json',
   {
-    auth: '测试日志记录',
+    permission: '测试日志记录',
     module: '信息',
     mount: true
   },
@@ -36,7 +36,7 @@ test.linGet(
   'getTestInfo',
   '/info',
   {
-    auth: '查看lin的信息',
+    permission: '查看lin的信息',
     module: '信息',
     mount: true
   },

app/api/cms/user.js

@@ -25,7 +25,7 @@ user.linPost(
   'userRegister',
   '/register',
   {
-    auth: '注册',
+    permission: '注册',
     module: '用户',
     mount: false
   },
@@ -45,7 +45,7 @@ user.linPost(
   'userLogin',
   '/login',
   {
-    auth: '登陆',
+    permission: '登陆',
     module: '用户',
     mount: false
   },
@@ -69,7 +69,7 @@ user.linPut(
   'userUpdate',
   '/',
   {
-    auth: '更新用户信息',
+    permission: '更新用户信息',
     module: '用户',
     mount: false
   },
@@ -88,7 +88,7 @@ user.linPut(
   'userUpdatePassword',
   '/change_password',
   {
-    auth: '修改密码',
+    permission: '修改密码',
     module: '用户',
     mount: false
   },
@@ -112,7 +112,7 @@ user.linGet(
   'userGetToken',
   '/refresh',
   {
-    auth: '刷新令牌',
+    permission: '刷新令牌',
     module: '用户',
     mount: false
   },
@@ -131,7 +131,7 @@ user.linGet(
   'userGetPermissions',
   '/permissions',
   {
-    auth: '查询自己拥有的权限',
+    permission: '查询自己拥有的权限',
     module: '用户',
     mount: true
   },
@@ -146,7 +146,7 @@ user.linGet(
   'getInformation',
   '/information',
   {
-    auth: '查询自己信息',
+    permission: '查询自己信息',
     module: '用户',
     mount: true
   },

app/api/v1/book.js

@@ -72,7 +72,7 @@ bookApi.linDelete(
   'deleteBook',
   '/:id',
   {
-    auth: '删除图书',
+    permission: '删除图书',
     module: '图书',
     mount: true
   },

app/middleware/jwt.js

@@ -112,7 +112,7 @@ async function groupRequired (ctx, next) {
       if (ctx.matched) {
         const routeName = ctx._matchedRouteName || ctx.routerName;
         const endpoint = `${ctx.method} ${routeName}`;
-        const { auth, module } = routeMetaInfo.get(endpoint);
+        const { permission, module } = routeMetaInfo.get(endpoint);
         const userGroup = await UserGroupModel.findAll({
           where: {
             user_id: ctx.currentUser.id
@@ -129,7 +129,7 @@ async function groupRequired (ctx, next) {
         const permissionIds = uniq(groupPermission.map(v => v.permission_id));
         const item = await PermissionModel.findOne({
           where: {
-            name: auth,
+            name: permission,
             module,
             id: {
               [Op.in]: permissionIds

app/middleware/logger.js

@@ -13,7 +13,7 @@ const REG_XP = /(?<=\{)[^}]*(?=\})/g;
  *  "getTestMsg",
  * "/json",
  *  {
- *   auth: "hello",
+ *   permission: "hello",
  *   module: "world",
  *   mount: true
  * },
@@ -44,9 +44,9 @@ function writeLog (template, ctx) {
   );
   if (ctx.matched) {
     const info = findAuthAndModule(ctx);
-    let auth = '';
+    let permission = '';
     if (info) {
-      auth = get(info, 'auth');
+      permission = get(info, 'permission');
     }
     const statusCode = ctx.status || 0;
     LogModel.createLog(
@@ -57,7 +57,7 @@ function writeLog (template, ctx) {
         status_code: statusCode,
         method: ctx.request.method,
         path: ctx.request.path,
-        permission: auth
+        permission
       },
       true
     );

app/models/permission.js

@@ -19,26 +19,26 @@ class Permission extends Model {
       transaction = await sequelize.transaction();
       const info = Array.from(routeMetaInfo.values());
       const permissions = await this.findAll();
-      for (const { auth, module: moduleName } of info) {
+      for (const { permission: permissionName, module: moduleName } of info) {
         if (
           permissions.find(
             permission =>
-              permission.name === auth && permission.module === moduleName
+              permission.name === permissionName && permission.module === moduleName
           )
         ) {
           continue;
         }
         await this.create(
           {
-            name: auth,
+            name: permissionName,
             module: moduleName
           },
           { transaction }
         );
       }
       const permissionIds = [];
       for (const { id, name, module: moduleName } of permissions) {
-        if (info.find(val => val.auth === name && val.module === moduleName)) {
+        if (info.find(val => val.permission === name && val.module === moduleName)) {
           continue;
         }
         await this.destroy({

package.json

@@ -46,7 +46,8 @@
     "koa-bodyparser": "^4.2.1",
     "koa-mount": "^4.0.0",
     "koa-static": "^5.0.0",
-    "lin-mizar": "^0.3.1",
+    "lin-mizar": "^0.3.2",
+    "mysql2": "^2.1.0",
     "sequelize": "^5.3.5"
   }
 }