Merge pull request #144 from sparcs-kaist/feature/board

Zabo boards 서비스 관련 API 작업

.docker/docker-compose.yml

@@ -53,6 +53,20 @@ services:
       - DB_STR=zabo
     volumes:
       - zabo-scheduler-log:/backup_log:rw
+
+#  zabo-worker:
+#    container_name: zabo-worker
+#    restart: always
+#    build:
+#      context: ..
+#      dockerfile: .worker/Dockerfile
+#    environment:
+#      - NODE_ENV=${NODE_ENV:-production}
+#      - MINIMUM_LOG_LEVEL=info
+#      - MONGODB_URL=mongodb://zabo-mongo:27017/zabo
+#      - DB_STR=zabo
+#    volumes:
+#      - zabo-worker-log:/backup_log:rw
 
 volumes:
   zabo-server-log:
@@ -61,3 +75,5 @@ volumes:
     external: true
   zabo-scheduler-log:
     external: true 
+#  zabo-worker-log:
+#    external: true

.gitignore

@@ -1,5 +1,6 @@
 # See https://help.github.com/ignore-files/ for more about ignoring files.
 
+.uuid 
 # dependencies
 /node_modules
 

.uuid

@@ -0,0 +1 @@
+a957a967-540e-49b2-b11a-17f32887ba0f

.worker/Dockerfile

@@ -0,0 +1,14 @@
+FROM node:16-alpine
+
+
+RUN apk add --no-cache git
+
+WORKDIR '/app'
+
+COPY ./package.json ./
+COPY ./yarn.lock ./
+RUN yarn
+
+COPY . .
+
+CMD ["node", "worker.js"]

package.json

@@ -37,9 +37,11 @@
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-react": "^7.18.6",
     "@babel/register": "^7.21.0",
+    "@tiptap/pm": "^2.3.1",
     "adminjs": "^6.8.7",
     "aws-sdk": "^2.485.0",
     "axios": ">=0.18.1",
+    "bcrypt": "^5.1.1",
     "chalk": "^2.4.2",
     "connect-redis": "^3.4.1",
     "cors": "^2.8.5",
@@ -56,7 +58,7 @@
     "http-errors": "~1.6.2",
     "ioredis": "^4.14.1",
     "jsonwebtoken": "^8.5.1",
-    "lodash": "^4.17.19",
+    "lodash": "^4.17.21",
     "migrate-mongoose": "^4.0.0",
     "moment": "^2.24.0",
     "mongoose": "^5.7.5",
@@ -84,7 +86,7 @@
     "figlet": "^1.2.4",
     "husky": "^4.0.6",
     "inquirer": "^7.0.3",
-    "lint-staged": "^9.5.0",
+    "lint-staged": "^15.1.0",
     "nodemon": "^1.18.11",
     "prettier": "^1.17.0"
   },

routes.md

@@ -46,6 +46,14 @@
 * [`POST`](routes.md) /zabo/:zaboId/share
 * [`DELETE`](routes.md) /zabo/:zaboId/
 
+### Board
+* [`POST`](routes.md) /board/device
+* [`DELETE`](routes.md) /board/device
+* [`POST`](routes.md) /board/login
+* [`POST`](routes.md) /board/logout
+* [`GET`](routes.md) /board/list
+
+
 ## Authentication
 
 Following **Authorization** field must be set in HTTP request header
@@ -361,6 +369,40 @@ TODO: 그룹의 정보 \(사진\)을 업데이트할 수 있습니다. 이름도
 
 400 : null id 500
 
+### Board
+#### `POST` /board/device { name, description, password } => deviceInfo
+자보 보드를 게시할 디바이스를 생성합니다. Admin 패널에서 생성할 수 있습니다.
+Admin 권한이 필요합니다. 기존의 디바이스들과 이름이 겹치면 생성되지 않습니다.
+
+유효성 확인
+* 관리자이여야 합니다.
+* 기존의 디바이스와 겹치지 않는 디바이스 이름이여야 합니다.
+
+#### `DELETE` /board/device { name } => { message }
+자보 보드를 게시하는 디바이스를 삭제합니다. Admin 패널에서 삭제할 수 있습니다.
+
+유효성 확인
+* 관리자이여야 합니다.
+* 유효한 디바이스 이름이여야 합니다.
+
+#### `POST` /board/login { name, password } => { success, message }
+자보 보드 디바이스에 로그인합니다. 세션 쿠키를 사용하여 인증합니다.
+
+유효성 확인
+* 올바른 디바이스 이름 및 비밀번호인지 확인합니다.
+
+#### `POST` /board/logout => { message }
+자보 보드 디바이스에서 로그아웃합니다. 
+
+유효성 확인
+* 디바이스로 로그인되어있어야 합니다.
+
+#### `GET` /board/list => zaboList
+디바이스에서 자보 보드용 자보를 받아옵니다. 디바이스 로깅을 위해 /zabo/list와 분리해서 사용해야 합니다.
+
+유효성 확인
+* 디바이스로 로그인되어있어야 합니다.
+
 ## English
 
 #### `GET` /auth \(\) ⇒ `user`

src/admin/actions/addDevice.js

@@ -0,0 +1,6 @@
+import { Components } from "../components";
+
+export const addDeviceAction = {
+  actionType: "resource",
+  component: Components.addDeviceComponent,
+};

src/admin/actions/deleteDevice.js

@@ -0,0 +1,20 @@
+import axios from "axios";
+export const deleteDeviceAction = {
+  actionType: "record",
+  component: false,
+  guard: "Do you really want to delete this device?",
+  handler: async (req, res, context) => {
+    const { record } = context;
+    const deviceName = record.params.name;
+    const response = await axios.delete("/api/board/device", {
+      name: deviceName,
+    });
+
+    response.data.message;
+
+    return {
+      record: {},
+      msg: "Deleting Device: Success",
+    };
+  },
+};

src/admin/components/addDevice.jsx

@@ -0,0 +1,51 @@
+import React, {useState} from 'react'
+import { H3, Input, Button } from '@adminjs/design-system';
+import axios from 'axios';
+
+const addDevice = async (name, description, password) => {
+    const response = await axios.post('/api/board/device',
+    {
+        name,
+        description,
+        password
+    }
+    );
+}
+
+const addDeviceComponent = (props) => {
+    const [name, setName] = useState("");
+    const [description, setDescription] = useState("");
+    const [password, setPassword] = useState("");
+
+    const handleNameChange = (e) => {
+        setName(e.target.value);
+    }
+
+    const handleDescriptionChange = (e) => {
+      setDescription(e.target.value);
+    }
+
+    const handlePasswordChange = (e) => {
+        setPassword(e.target.value);
+    }
+
+    const handleDeviceSubmit = async() => {
+        await addDevice(name, description, password);
+    }
+
+    return (
+        <div>
+            <H3> Create your zabo boards device</H3>
+            <br/>
+            <Input type="text" onChange={handleNameChange} placeholder="name" />
+            <br/>
+            <Input type="text" onChange={handleDescriptionChange} placeholder="description" />
+            <br/>
+            <Input type="password" onChange={handlePasswordChange} placeholder="password" />
+            <br/>
+            <Button size="icon" rounded="True" onClick={handleDeviceSubmit}>Submit</Button>
+        </div>
+    )
+}
+
+export default addDeviceComponent

src/admin/components/index.js

@@ -7,6 +7,7 @@ const Components = {
     "uploadZaboComponent",
     "./uploadZabo",
   ),
+  addDeviceComponent: componentLoader.add("addDeviceComponent", "./addDevice"),
 };
 
 export { componentLoader, Components };

src/admin/components/uploadZabo.jsx

@@ -130,7 +130,7 @@ const uploadZaboComponent =  (props) => {
     await sortedImageFiles.sort(gridLayoutCompareFunction);
 
     const {width, height} = await imageFileGetWidthHeight(sortedImageFiles[0]);
-    const ratio = width / height;
+    let ratio = width / height;
     if (ratio > 2) ratio = 2;
     else if (ratio < 0.5) ratio = 0.5;
     const sources = await Promise.all(sortedImageFiles.map((file) => cropImage(file, ratio)));
@@ -146,7 +146,6 @@ const uploadZaboComponent =  (props) => {
       },
   });
 
-    return
   }
 
   return (

src/admin/index.js

@@ -12,11 +12,13 @@ import {
   Statistic,
   PreRegister,
   Meta,
+  DeviceLog,
 } from "../db";
 
 import { GroupResource } from "./resources/Group";
 import { ZaboResource } from "./resources/Zabo";
 import { AdminUserResource } from "./resources/AdminUser";
+import { DeviceResource } from "./resources/Device";
 
 AdminJS.registerAdapter({
   Resource: AdminJSMongoose.Resource,
@@ -34,7 +36,9 @@ const adminOptions = {
     Statistic,
     PreRegister,
     Meta,
+    DeviceResource,
     ZaboResource,
+    DeviceLog,
   ],
   componentLoader,
 };

src/admin/resources/Device.js

@@ -0,0 +1,11 @@
+import { Device } from "../../db/index";
+import { addDeviceAction } from "../actions/addDevice";
+
+export const DeviceResource = {
+  resource: Device,
+  options: {
+    actions: {
+      addDevice: addDeviceAction,
+    },
+  },
+};