後端API測試 (Boxun/Jenny)

.ebextensions/migration.config

@@ -0,0 +1,5 @@
+option_settings:
+container_commands:
+  01_schema_migrate:
+    command: ./node_modules/.bin/sequelize db:migrate
+    leader_only: true

.env.example

@@ -0,0 +1,2 @@
+JWT_SECRET=
+IMGUR_CLIENT_ID=

.eslintignore

@@ -0,0 +1,2 @@
+/node_modules/*
+/tests/*

.eslintrc.yml

@@ -0,0 +1,12 @@
+env:
+  browser: true
+  commonjs: true
+  es2021: true
+extends:
+  - standard
+parserOptions:
+  ecmaVersion: 12
+rules:
+  arrow-parens:
+    - warn
+    - as-needed

.gitattributes

@@ -0,0 +1,53 @@
+*                 text=auto
+
+# Source code
+*.css             text diff=css
+*.html            text diff=html
+*.js              text
+*.json            text
+
+# Documentation
+*.markdown        text diff=markdown
+*.md              text diff=markdown
+*.txt             text
+
+# Templates
+*.handlebars      text
+*.hbs             text
+
+# Configs
+*.cnf             text
+*.conf            text
+*.config          text
+.editorconfig     text
+.env              text
+.env.*            text
+.gitattributes    text
+.gitconfig        text
+*.lock            text -diff
+package.json      text eol=lf
+package-lock.json text -diff
+yarn.lock         text -diff
+*.yaml            text
+*.yml             text
+browserslist      text
+
+# Heroku
+Procfile          text
+
+# Graphics
+*.gif             binary
+*.ico             binary
+*.jpg             binary
+*.jpeg            binary
+*.pdf             binary
+*.png             binary
+# SVG treated as an asset (binary) by default.
+*.svg             text
+# If you want to treat it as binary,
+# use the following line instead.
+# *.svg           binary
+*.webp            binary
+
+# Ignore files (like .npmignore or .gitignore)
+*.*ignore         text

.gitignore

@@ -84,4 +84,13 @@ typings/
 .fusebox/
 
 # DynamoDB Local files
-.dynamodb/
+.dynamodb/
+
+# image upload directories
+temp/
+upload/
+
+# Elastic Beanstalk Files
+.elasticbeanstalk/*
+!.elasticbeanstalk/*.cfg.yml
+!.elasticbeanstalk/*.global.yml

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-    - "14"
+    - "16"
 
 services:
   - mysql
@@ -13,6 +13,7 @@ env:
 before_install:
   - mysql -e 'CREATE DATABASE IF NOT EXISTS ac_twitter_workspace_test default character set utf8mb4 collate utf8mb4_unicode_ci;'
   - npm install sequelize-cli -g
+  - export JWT_SECRET=alphacamp
 
 # 在執行測試之前的指令
 before_script:

Procfile

@@ -0,0 +1 @@
+web: NODE_ENV=production node app.js

README.md

@@ -0,0 +1,100 @@
+# Simple Twitter API
+- 這是一個類 Twtter 的社群網站，透過推文、回覆、喜歡、追蹤等功能與其他人進行互動
+- 本專案採用前後分離的開發模式，並透過 RESTful 風格進行設計
+  - 後端成員：[Boxun](https://github.com/boxunw), [Jenny](https://github.com/yanyanyaa)
+  - 前端成員：[James](https://github.com/James-Lee-01), [雅云](https://github.com/Ya-Yun-Zheng)
+  - [前端 repo](https://github.com/James-Lee-01/simple-twitter)
+  - [網站入口](https://simple-twitter-eight.vercel.app)
+
+# 功能
+- 使用者可以註冊/登入帳號
+- 使用者可以瀏覽所有推文
+- 使用者可以回覆所有推文
+- 使用者可以喜歡/收回喜歡任何推文
+- 使用者可以追蹤/取消追蹤其他使用者
+- 使用者可以瀏覽其他使用者的個人頁面
+- 使用者可以編輯個人資料與帳戶設定
+- 後台管理者可以瀏覽所有推文清單，並且快覽推文的前 50 字
+- 後台管理者可以瀏覽所有使用者清單，並附有使用者社群活躍數據
+- 後台管理者可以刪除任何一篇推文
+# API 文件
+[API List](https://documenter.getpostman.com/view/29236995/2s9Y5cu1Rv#f83c365c-642e-4f90-b6c1-185551187722)
+# 安裝
+1. 請先確認有安裝 node.js 與 npm
+2. 打開終端機，clone 此專案
+```
+git clone https://github.com/boxunw/simple-twitter-api.git
+```
+3. 打開專案資料夾
+```
+cd simple-twitter-api
+```
+4. 安裝 npm 套件
+```
+npm install
+```
+5. 參考 .env.example 檔案，建立 .env 檔案並設定環境變數
+6. 打開 /config/config.json 檔案，修改為資料庫使用的帳號密碼
+```
+"development": {
+  "username": "<your_mysql_workbench_name>",   // 修改此處
+  "password": "<your_mysql_workbench_password>",   // 修改此處
+  "database": "ac_twitter_workspace",
+  "host": "127.0.0.1",
+  "dialect": "mysql"
+},
+"test": {
+  "username": "<your_mysql_workbench_name>",   // 修改此處
+  "password": "<your_mysql_workbench_password>",   // 修改此處
+  "database": "ac_twitter_workspace_test",
+  "host": "127.0.0.1",
+  "dialect": "mysql",
+  "logging": false
+},
+```
+7. 建立資料庫，可在 MySQL Workbench 輸入以下指令
+```
+create database ac_twitter_workspace;
+create database ac_twitter_workspace_test;
+```
+8. 建立資料表
+```
+npx sequelize db:migrate
+```
+9. 建立種子資料
+```
+npx sequelize db:seed:all
+```
+10. 啟動伺服器
+```
+npm run dev
+```
+11. 當終端機出現以下字樣，表示伺服器已成功啟動
+```
+Example app listening on port 3000!
+```
+# 測試帳號
+```
+管理者
+Account: root
+Password: 12345678
+
+一般使用者
+Account: user1
+Password: 12345678
+```
+# 自動化測試
+1. 切換至測試環境
+```
+export NODE_ENV=test
+```
+2. 執行自動化測試（全部）
+```
+npm run test
+```
+3. 執行自動化測試（單一檔案）
+```
+npx mocha test/requests/user.spec.js --exit  // 範例
+```
+
+

_helpers.js

@@ -1,8 +1,13 @@
 
-function getUser(req) {
-  return req.user;
+function getUser (req) {
+  return req.user || null
+}
+
+function ensureAuthenticated (req) {
+  return req.isAuthenticated()
 }
 
 module.exports = {
   getUser,
-};
+  ensureAuthenticated
+}

app.js

@@ -1,15 +1,36 @@
+if (process.env.NODE_ENV !== 'production') {
+  require('dotenv').config()
+}
+const path = require('path')
 const express = require('express')
-const helpers = require('./_helpers');
+const cors = require('cors')
+const methodOverride = require('method-override')
+const { apis } = require('./routes')
+const passport = require('./config/passport')
 
 const app = express()
-const port = 3000
+const port = process.env.PORT || 3000
 
-// use helpers.getUser(req) to replace req.user
-function authenticated(req, res, next){
-  // passport.authenticate('jwt', { ses...
-};
+// set CORS
+const corsOptions = {
+  origin: [
+    'https://james-lee-01.github.io',
+    'http://localhost:3000'
+  ],
+  methods: 'GET,HEAD,PUT,PATCH,POST,DELETE,OPTIONS',
+  allowedHeaders: ['Content-Type', 'Authorization']
+}
 
-app.get('/', (req, res) => res.send('Hello World!'))
+app.use(cors(corsOptions))
+
+app.use(express.urlencoded({ extended: true }))
+app.use(express.json())
+app.use(passport.initialize())
+app.use(passport.session())
+app.use(methodOverride('_method'))
+app.use('/upload', express.static(path.join(__dirname, 'upload')))
+app.use('/api', apis)
+app.get('/', (req, res) => res.json({ status: 'success' }))
 app.listen(port, () => console.log(`Example app listening on port ${port}!`))
 
 module.exports = app

config/config.json

@@ -15,11 +15,8 @@
     "logging": false
   },
   "production": {
-    "username": "root",
-    "password": null,
-    "database": "database_production",
-    "host": "127.0.0.1",
-    "dialect": "mysql"
+    "use_env_variable": "MYSQL_DATABASE_URL",
+    "operatorsAliases": false
   },
   "travis": {
     "username": "travis",
@@ -34,4 +31,4 @@
     "host": "127.0.0.1",
     "dialect": "mysql"
   }
-}
+}

config/passport.js

@@ -1,5 +1,47 @@
 const passport = require('passport')
+const LocalStrategy = require('passport-local')
+const passportJWT = require('passport-jwt')
+const bcrypt = require('bcryptjs')
+const { User } = require('../models')
 
+const JWTStrategy = passportJWT.Strategy
+const ExtractJWT = passportJWT.ExtractJwt
 
+// set up Passport Local strategy
+passport.use(new LocalStrategy(
+  // customize user field
+  {
+    usernameField: 'account',
+    passwordField: 'password'
+  },
+  // authenticate user
+  (account, password, cb) => {
+    User.findOne({ where: { account } })
+      .then(user => {
+        if (!user) return cb(Error('帳號不存在'), false)
+        bcrypt.compare(password, user.password).then(res => {
+          if (!res) return cb(Error('輸入密碼錯誤'), false)
+          return cb(null, user)
+        })
+      })
+      .catch(err => cb(err))
+  }
+))
 
-module.exports = passport
+// set up Passport Jwt strategy
+const jwtOptions = {
+  jwtFromRequest: ExtractJWT.fromAuthHeaderAsBearerToken(),
+  secretOrKey: process.env.JWT_SECRET
+}
+passport.use(new JWTStrategy(jwtOptions, (jwtPayload, cb) => {
+  User.findByPk(jwtPayload.id, {
+    include: [
+      { model: User, as: 'Followers' },
+      { model: User, as: 'Followings' }
+    ]
+  })
+    .then(user => cb(null, user))
+    .catch(err => cb(err))
+}))
+
+module.exports = passport