前後分離組 (YUNJONE / 葉明荃 / Eric Huang / 江祐敏)

.env.example

@@ -0,0 +1,8 @@
+SESSION_SECRET=SKIP
+JWT_SECRET=SKIP
+
+# IMGUR相關
+IMGUR_CLIENT_ID=SKIP
+IMGUR_CLIENT_SECRET=SKIP
+IMGUR_CLIENT_REFRESH_TOKEN=SKIP
+IMGUR_ALBUM_ID=SKIP

.eslintignore

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

.eslintrc.yml

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

.gitignore

@@ -1,6 +1,10 @@
 .DS_Store
 *.DS_Store
 
+# multer
+upload/
+
+
 # Logs
 logs
 *.log

Procfile

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

README.md

@@ -0,0 +1,123 @@
+# Simple Twitter API
+
+* 一個簡易的twitter專案，提供使用者發文、回覆，以及喜歡和追蹤等和其他使用者互動的方式，並提供後台管理功能。
+* 本專案為後端API部份，和Simple Twitter React[前端專案](https://github.com/u88872625/simple-twitter)共同使用才是完整專案。
+
+## 功能說明
+
+* 提供個人帳密註冊、登入、登出。
+* 使用者可以維護個人基本資料、並可上傳自訂的頭貼和背景。
+* 使用者可以發表推文以及回覆。
+* 使用者可以追蹤其他使用者，也可以對其他使用者的推文按喜歡。
+* 查看其他使用者資訊、發表的推文、回覆、追蹤中和追隨中的人等
+* 提供推薦的使用者名單
+* 後台管理功能：瀏覽全站使用者、瀏覽及刪除全站推文。
+
+
+## 安裝與執行
+
+1. 請先確認安裝有node.js及npm
+2. 開啟終端機，進入專案目錄，並從github下載資料
+
+```bash
+> git clone https://github.com/AlanChiangg/twitter-api-2020.git
+```
+
+3. 安裝套件
+
+```bash
+> cd twitter-api-2020
+> npm install
+```
+
+4. 設定環境變數: 在專案資料夾下的.env.example檔案名稱修改為.env，並填入你的JWT暗碼及IMGUR應用程式資料
+```
+SESSION_SECRET=<SESSION的暗碼>
+JWT_SECRET=<JWT的暗碼>
+
+# IMGUR相關
+IMGUR_CLIENT_ID=<IMGUR應用程式的的ID>
+IMGUR_CLIENT_SECRET=<IMGUR應用程式的的SECRET>
+IMGUR_CLIENT_REFRESH_TOKEN=<IMGUR應用程式的的REFRESH_TOKEN>
+IMGUR_ALBUM_ID=<自有IMGUR相簿的ID>
+```
+
+5. 設定資料庫：設定連線資訊。如果是開發環境，可直接在config.json中做設定，如果是佈署的情況，要設定對應的環境變數。
+```
+MYSQL_DATABASE_URL=<MySQL連線字串>
+```
+6. 如果是新資料庫，需要重新產生資料表結構
+```bash
+> npx sequelize db:migrate
+```
+
+5. 設定種子資料: 在終端機執行底下指令，匯入種子資料到資料庫裡
+```bash
+> npm run seed
+
+```
+
+6. 執行程式，啟動監聽
+
+```
+> npm run start
+```
+
+7. 啟動程式後，API即開始進行監聽。
+
+## 提供的API列表
+
+| 項次 |                 路由                 |                 功能                 |
+|:---- |:------------------------------------|:------------------------------------ |
+|      | 和sign up/sign in相關                |                                      |
+| 1    | POST /api/users                      | 註冊帳號                             |
+| 2    | POST /api/users/signin               | 登入前台帳號                         |
+|      | 和User相關                           |                                      |
+| 3    | GET /api/users/:id                   | 查看某使用者的資料                   |
+| 4    | GET /api/users/:id/tweets            | 查看某使用者發過的推文               |
+| 5    | GET /api/users/:id/replied_tweets    | 查看某使用者發過的回覆               |
+| 6    | GET /api/users/:id/likes             | 查看某使用者點過like的推文           |
+| 7    | GET /api/users/:id/followings        | 查看某使用者追蹤中的人               |
+| 8    | GET /api/users/:id/followers         | 查看某使用者的追隨者                 |
+| 9    | GET /api/users? {limit=10}           | 查看跟隨者數量排名(前10)的使用者資料 |
+| 10   | PUT /api/users/:id                   | 編輯使用者資料                       |
+|      | 和Followship相關                     |                                      |
+| 11   | POST /api/followships                | 追蹤一個使用者                       |
+| 12   | DELETE /api/followships/:followingId | 取消追蹤一個使用者                   |
+|      | 和Tweet相關                          |                                      |
+| 13   | GET /api/tweets                      | 查看所有的推文                       |
+| 14   | GET /api/tweets/:id                  | 查看某一則貼文                       |
+| 15   | POST /api/tweets                     | 發布一則推文                         |
+|      | 和Reply相關                          |                                      |
+| 16   | POST /api/tweets/:id/replies         | 發佈一則回覆                         |
+| 17   | GET /api/tweets/:id/replies          | 查看某一則貼文的所有回文             |
+|      | 和Like相關                           |                                      |
+| 18   | POST /api/tweets/:id/like            | 喜歡一則推文                         |
+| 19   | POST /api/tweets/:id/unlike          | 取消喜歡一則推文                     |
+|      | 和後台管理相關                       |                                      |
+| 20   | POST /api/admin/signin               | 登入後台帳號                         |
+| 21   | GET /api/admin/users                 | 取得所有使用者清單                   |
+| 22   | GET /api/admin/tweets                | 取得所有推文清單                     |
+| 23   | DELETE /api/admin/tweets/:id         | 刪除特定推文                         |
+
+
+
+## 開發環境與主要套件
+
+* VS Code - 編程環境
+* node.js / [email protected] - 後端框架
+* [email protected] / [email protected] - 資料庫管理
+* [email protected] - 認證策略
+* [email protected] - 時間格式化
+* [email protected] / imgur - 圖檔上傳
+
+底下為開發中使用
+* [email protected] - 管理環境變數
+* [email protected] - 代碼風格
+
+## 作者
+
+* [**江祐敏**](https://github.com/AlanChiangg)
+* [**Eric Huang**](https://github.com/erikku54) 
+
+前端專案合作： [**葉明荃**](https://github.com/u88872625)、[**YunJong**](https://github.com/Yunj0ng)

_helpers.js

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

app.js

@@ -1,15 +1,32 @@
+if (process.env.NODE_ENV !== 'production') {
+  require('dotenv').config()
+}
+
 const express = require('express')
-const helpers = require('./_helpers');
+// const session = require('express-session')
+const cors = require('cors')
+
+const passport = require('./config/passport')
+const { getUser } = require('./_helpers')
+const apis = require('./routes')
 
 const app = express()
-const port = 3000
+const port = process.env.PORT || 3000
+
+app.use(express.urlencoded({ extended: true }))
+app.use(express.json())
+// app.use(session({ secret: process.env.SESSION_SECRET || 'LittleSecret', resave: false, saveUninitialized: false }))
+app.use(passport.initialize())
+// app.use(passport.session())
+app.use(cors())
+
+app.use((req, res, next) => {
+  res.locals.user = getUser(req)
+  next()
+})
 
-// use helpers.getUser(req) to replace req.user
-function authenticated(req, res, next){
-  // passport.authenticate('jwt', { ses...
-};
+app.use('/api', apis)
 
-app.get('/', (req, res) => res.send('Hello World!'))
 app.listen(port, () => console.log(`Example app listening on port ${port}!`))
 
 module.exports = app

config/config.json

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

config/passport.js

@@ -1,5 +1,69 @@
 const passport = require('passport')
+const LocalStrategy = require('passport-local')
+const passportJWT = require('passport-jwt')
+const bcrypt = require('bcryptjs')
+const { User } = require('../models')
 
+const ExtractJWT = passportJWT.ExtractJwt
+const JWTStrategy = passportJWT.Strategy
 
+// local strategy
+passport.use(new LocalStrategy(
+  {
+    usernameField: 'account',
+    passwordField: 'password'
+  },
+  async (account, password, done) => {
+    try {
+      const cause = { // 定義不同的錯誤訊息，以便前端顯示之用
+        accountErrMsg: '',
+        passwordErrMsg: ''
+      }
 
-module.exports = passport
+      // 確認必填值是否為空
+      if (!account) cause.accountErrMsg += '此為必填欄位。'
+      if (!password) cause.passwordErrMsg += '此為必填欄位。'
+      if (cause.accountErrMsg || cause.passwordErrMsg) {
+        throw new Error('Empty input value!', { cause })
+      }
+
+      // 確認帳號是否存在
+      const user = await User.findOne({ where: { account } })
+      if (!user) {
+        cause.accountErrMsg += '帳號不存在！'
+        throw new Error('User does not exist!', { cause })
+      }
+
+      // 確認密碼是否正確
+      const result = await bcrypt.compare(password, user.password)
+      if (!result) {
+        cause.passwordErrMsg += '不正確的密碼！'
+        throw new Error('Incorrect password!', { cause })
+      }
+
+      return done(null, user)
+    } catch (err) {
+      return done(err)
+    }
+  }
+))
+
+// jwt strategy
+const jwtOptions = {
+  jwtFromRequest: ExtractJWT.fromAuthHeaderAsBearerToken(),
+  secretOrKey: process.env.JWT_SECRET || 'SecretTime'
+}
+
+passport.use(new JWTStrategy(jwtOptions, async (jwtPayload, done) => {
+  try {
+    const user = await User.findByPk(jwtPayload.id)
+    if (!user) return done(null, false)
+
+    return done(null, user)
+  } catch (error) {
+    return done(error)
+  }
+})
+)
+
+module.exports = passport