Simple Twitter 專案 - Kelly組 (Kelly, Kevin, Chia-Hsuan, Aray)

.env.example

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

.eslintignore

@@ -0,0 +1,3 @@
+/node_modules/*
+/test/*
+/models/index.js

.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

@@ -1,3 +1,7 @@
+node_modules/
+temp/
+upload/
+
 .DS_Store
 *.DS_Store
 

.travis.yml

@@ -16,4 +16,5 @@ before_install:
 
 # 在執行測試之前的指令
 before_script:
+  - echo "JWT_SECRET=alphacamp" >> .env
   - sequelize db:migrate

Procfile

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

README.md

@@ -0,0 +1,101 @@
+# Simple Twitter API 2023
+
+## v1.0.0
+
+## About The Project
+![Alt text](image-1.png)
+
+A RESTful API server for Simple Twitter project built with Node.js, Express framework, and MySQL.
+
+## Usage
+
+Through this web program, after the user registers an account, users can use post, reply to other user's tweets, like other users' tweets, track other users, and use the account settings functions like uploading profile picture, uploading cover page photo, etc.
+
+_Check this out to view more - [documentation](https://magic9701.github.io/Simple-Twitter/)_
+
+### Base URL
+   ```sh
+https://pure-falls-11392.herokuapp.com/
+   ```
+
+### Installation
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/av124773/twitter-api-2020.git
+   ```
+2. Install NPM packages
+   ```sh
+   npm install
+   ```
+3. Create database via SQL WorkBench(enter in WorkBench Application)
+   ```sh
+   create database ac_twitter_workspace
+   ```
+4. Create models
+   ```sh
+   npx sequelize db:migrate
+   ```
+5. Create built-in data via seeds
+   ```sh
+   npx sequelize db:seed:all
+   ```
+6. Establish .env file and put passowrds in
+   ```sh
+   IMGUR_CLIENT_ID= 'YOUR PASSWORD'
+   JWT_SECRET= 'YOUR PASSWORD'
+   ```
+7. Start the server
+   ```sh
+   - MacOS
+    npm run start
+   - Windows OS
+    npm run startWin
+   ```
+
+## Getting Started
+Use the default accounts to login
+   ```sh
+   - User
+    account: user1
+    email: user1@example.com
+    password: 12345678
+   - Admin
+    account: root
+    email: root@example.com
+    password: 12345678
+   ```
+
+## Environment
+- node: ^v14.16.0,
+- nodemon
+
+## Built With
+- bcrypt-nodejs: ^0.0.3,
+- bcryptjs: ^2.4.3,
+- body-parser: ^1.18.3,
+- chai: ^4.2.0,
+- connect-flash: ^0.1.1,
+- cors: ^2.8.5,
+- dotenv: ^16.1.4,
+- express: ^4.16.4,
+- express-session: ^1.15.6,
+- faker: ^4.1.0,
+- imgur: ^1.0.2,
+- jsonwebtoken: ^8.5.1,
+- method-override: ^3.0.0,
+- mocha: ^6.0.2,
+- multer: ^1.4.4,
+- mysql2: ^1.6.4,
+- passport: ^0.4.1,
+- passport-jwt: ^4.0.0,
+- passport-local: ^1.0.0,
+- sequelize: ^6.18.0,
+- sequelize-cli: ^5.5.0,
+- sinon: ^10.0.0,
+- sinon-chai: ^3.3.0,
+- tslib: ^2.5.3
+
+## Contributors
+- Kevin_L [https://github.com/av124773](https://github.com/av124773)
+- Chia-Hsuan Chu [https://github.com/jiasyuanchu](https://github.com/jiasyuanchu)

_helpers.js

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

app.js

@@ -1,15 +1,31 @@
+if (process.env.NODE_ENV !== 'production') {
+  require('dotenv').config()
+}
+
 const express = require('express')
-const helpers = require('./_helpers');
+const bodyParser = require('body-parser')
+const cors = require('cors')
+const routes = require('./routes')
+
+const methodOverride = require('method-override')
+
+const passport = require('./config/passport')
 
 const app = express()
-const port = 3000
+const port = process.env.PORT || 3000
+
+// middleware
+app.use(cors())
+app.use(bodyParser.json())
+app.use(express.urlencoded({ extended: true }))
+app.use(express.json())
+app.use(passport.initialize())
+app.use(passport.session())
+app.use(methodOverride('_method'))
 
-// use helpers.getUser(req) to replace req.user
-function authenticated(req, res, next){
-  // passport.authenticate('jwt', { ses...
-};
+app.use(express.urlencoded({ extended: true }))
 
-app.get('/', (req, res) => res.send('Hello World!'))
+app.use(routes)
 app.listen(port, () => console.log(`Example app listening on port ${port}!`))
 
 module.exports = app

config/config.json

@@ -15,11 +15,7 @@
     "logging": false
   },
   "production": {
-    "username": "root",
-    "password": null,
-    "database": "database_production",
-    "host": "127.0.0.1",
-    "dialect": "mysql"
+    "use_env_variable": "CLEARDB_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 JWTStrategy = passportJWT.Strategy
+const ExtractJWT = passportJWT.ExtractJwt
+const bcrypt = require('bcryptjs')
 
+const { User } = require('../models')
 
+// set up local Passport strategy
+passport.use(new LocalStrategy({
+  usernameField: 'account',
+  passwordField: 'password'
+}, async (account, password, done) => {
+  try {
+    const user = await User.findOne({
+      where: { account } // user checking by account
+    })
+    if (!user) {
+      return done(null, false, { status: 401, message: '帳號不存在' })
+    }
+    const isMatch = await bcrypt.compare(password, user.password)
+    if (!isMatch) {
+      return done(null, false, { status: 401, message: '密碼錯誤' })
+    }
+    return done(null, user.get())
+  } catch (err) {
+    return done(err, false)
+  }
+}))
 
-module.exports = passport
+// middleware for jwt
+const jwtOptions = {
+  jwtFromRequest: ExtractJWT.fromAuthHeaderAsBearerToken(),
+  secretOrKey: process.env.JWT_SECRET
+}
+
+// jwtStrategy
+passport.use(new JWTStrategy(jwtOptions, (jwtPayload, cb) => {
+  User.findByPk(jwtPayload.id, { // 拿payload裡面的id
+    include: [
+      { model: User, as: 'Followers' },
+      { model: User, as: 'Followings' }
+    ]
+  })
+    .then(user => {
+      if (!user) return cb(null, false)
+      return cb(null, user)
+    })
+    .catch(err => cb(err))
+})
+)
+
+// for local: serialize and deserialize user
+passport.serializeUser((user, cb) => {
+  cb(null, user.id)
+})
+passport.deserializeUser((id, cb) => {
+  return User.findByPk(id, { // 使以下可透過req.user查詢
+    include: [
+      { model: User, as: 'Followers' },
+      { model: User, as: 'Followings' }
+    ]
+  })
+    .then(user => cb(null, user.toJSON()))
+    .catch(err => cb(err))
+})
+
+module.exports = passport