feat: v1

Author: Markkop

.env.example

@@ -0,0 +1,5 @@
+APIKEY=
+MONGODB_USER=
+MONGODB_PASSWORD=
+MONGODB_URL=
+MONGODB_DATABASE=

.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true
+  },
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  rules: {
+    'no-unused-vars': 'warn',
+    "indent": "off",
+    "@typescript-eslint/indent": ["error", 2]
+  },
+}

.gihub/workflows/main.yml

@@ -0,0 +1,35 @@
+
+name: Build - Deploy
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.6.1]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: yarn
+    - run: yarn build
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: akhileshns/[email protected]
+        with:
+          heroku_api_key: ${{secrets.HEROKU_API_KEY}}
+          heroku_app_name: "upcoming-movies-markkop"
+          heroku_email: ${{secrets.HEROKU_EMAIL}}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.env
+dist

Procfile

@@ -0,0 +1 @@
+web: yarn start

README.md

@@ -0,0 +1,19 @@
+# 📟 Code-Codes - API
+
+This is the API version of the CodeCodes gamification Discord Bot.  
+This doc shall be improved someday
+
+## Routes
+
+All routes require a `x-apikey` as header
+
+### /token/claim [POST]
+Body:
+```
+{
+  "code": "CODECON21",
+  "id": "[email protected]",
+  "tag": "Mark Kop"
+}
+```
+

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "codecodes-api",
+  "version": "1.0.0",
+  "license": "MIT",
+  "author": "Marcelo 'Mark' Kopmann",
+  "scripts": {
+    "dev": "nodemon --watch 'src/' --exec 'ts-node src/index.ts' -e ts ",
+    "build": "tsc",
+    "start": "node dist/index.js"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "dotenv": "^10.0.0",
+    "express": "^4.17.1",
+    "mongoose": "^5.13.7",
+    "morgan": "^1.10.0"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.12",
+    "@types/express": "^4.17.13",
+    "@types/morgan": "^1.9.3",
+    "@types/node": "^16.6.1",
+    "@typescript-eslint/eslint-plugin": "^4.29.1",
+    "@typescript-eslint/parser": "^4.29.1",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.24.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "nodemon": "^2.0.12",
+    "ts-node": "^10.2.0",
+    "typescript": "^4.3.5"
+  }
+}

src/config.ts

@@ -0,0 +1,6 @@
+export default {
+  claim: {
+    enabled: true,
+    disabledMessage: "Resgates estão desabilitados. Obrigado por participar!"
+  }
+}

src/controllers/token.ts

@@ -0,0 +1,131 @@
+import { NextFunction, Request, Response } from 'express'
+import { getDatabaseTokenByCode, updateDatabaseToken } from '../services/token'
+import { getDatabaseUserById, updateDatabaseUser } from '../services/user'
+import config from '../config'
+
+export async function claim (request: Request, response: Response, next: NextFunction): Promise<void> {
+  try {
+    if (!config.claim.enabled) {
+      response.json({
+        status: 'error',
+        message: config.claim.disabledMessage
+      })
+      return
+    }
+
+    const { body: { code, email: userId, name: tag } } = request
+
+    if (!code) {
+      response.json({
+        status: 'error',
+        message: 'No code was provided'
+      })
+      return
+    }
+
+    const token = await getDatabaseTokenByCode(code)
+
+    const { claimedBy, remainingClaims, value, decreaseValue, minimumValue, expireAt } = token
+
+    if (!remainingClaims) {
+      response.json({
+        status: 'error',
+        message: 'Vish, acabaram os resgates disponíveis para esse token :('
+      })
+      return
+    }
+
+    const isExpired = expireAt && new Date(Date.now()) > new Date(expireAt)
+    if (isExpired) {
+      response.json({
+        status: 'error',
+        message: 'Esse token expirou :('
+      })
+      return
+    }
+
+    const hasAlreadyClaimed = claimedBy.some(claimedUser => claimedUser.id === userId)
+    if (hasAlreadyClaimed) {
+      response.json({
+        status: 'error',
+        message: 'Você já resgatou esse token :eyes:'
+      })
+      return
+    }
+
+    const timesClaimed = claimedBy.length
+    let scoreAcquired = value - (timesClaimed * decreaseValue)
+    if (scoreAcquired < minimumValue) {
+      scoreAcquired = minimumValue
+    }
+
+    let userCurrentScore = 0
+    let tokensClaimed = []
+    const user = await getDatabaseUserById(userId)
+    if (user) {
+      userCurrentScore = user.score
+      tokensClaimed = user.tokens
+    }
+
+    const score = {
+      acquired: scoreAcquired,
+      total: userCurrentScore + scoreAcquired
+    }
+
+    const date = new Date(Date.now())
+    const dateString = date.toISOString()
+    const claimUser = {
+      tag: tag,
+      id: String(userId),
+      claimedAt: dateString
+    }
+
+    const updatedToken = {
+      ...token,
+      remainingClaims: remainingClaims - 1,
+      claimedBy: claimedBy.concat(claimUser)
+    }
+
+    const updatedUser = {
+      userId,
+      tag,
+      score: score.total,
+      tokens: tokensClaimed.concat({
+        code,
+        value: scoreAcquired,
+        claimedAt: dateString
+      })
+    }
+
+    const userClaimSuccess = await updateDatabaseUser(updatedUser)
+    if (!userClaimSuccess) {
+      response.json({
+        status: 'error',
+        message: 'Putz, deu ruim ao atualizar o usuário'
+      })
+      return
+    }
+
+    const databaseUpdatedToken = await updateDatabaseToken(updatedToken)
+    if (!databaseUpdatedToken) {
+      response.json({
+        status: 'error',
+        message: 'Putz, deu ruim ao atualizar o token'
+      })
+      return
+    }
+
+    response.json({
+      status: 'success',
+      message: `O código ${code} foi resgatado por ${userId}.`
+    })
+    return
+  } catch (error) {
+    next(error)
+    console.log(error)
+  }
+}
+
+export default {
+  claim
+}

src/index.ts

@@ -0,0 +1,28 @@
+import dotenv from 'dotenv'
+dotenv.config()
+import express from 'express'
+import logger from 'morgan'
+import cors from 'cors'
+import token from './routes/token'
+import middlewares from './middewares'
+
+const PORT = process.env.PORT || 8080
+
+try {
+  const app = express()
+
+  app.use(cors())
+  app.use(logger('dev'))
+  app.use(express.json())
+
+  app.use('/token', token)
+
+  app.use(middlewares.notFound)
+  app.use(middlewares.errorHandler)
+
+  app.listen(PORT, () => {
+    console.log(`Server is running on port ${PORT}.`)
+  })
+} catch (error) {
+  console.error(error)
+}

src/middewares/errorHandler.ts

@@ -0,0 +1,8 @@
+import { Request, Response } from "express"
+
+export function errorHandler (error: Error, request: Request, response: Response): void {
+  response.status(505).json({
+    message: error.message,
+    stack: error.stack
+  })
+}

src/middewares/index.ts

@@ -0,0 +1,7 @@
+import { errorHandler } from "./errorHandler";
+import { notFound } from "./notFound";
+
+export default {
+  errorHandler,
+  notFound
+}

src/middewares/notFound.ts

@@ -0,0 +1,7 @@
+import { Request, Response } from "express"
+
+export function notFound (request: Request, response: Response): void {
+  response.status(404).json({
+    message: `Not Found - ${request.originalUrl}`
+  })
+}

src/middewares/validateApiKey.ts

@@ -0,0 +1,16 @@
+import { NextFunction, Request, Response } from 'express'
+
+export function validateApiKey (request: Request, response: Response, next: NextFunction): void {
+  try {
+    const apiKey = request.headers['x-apikey']
+    if (apiKey !== process.env.APIKEY) {
+      throw new Error('Wrong or missing apikey')
+    }
+    next()
+  } catch (error) {
+    response.json({
+      status: 'error',
+      message: error.message
+    })
+  }
+}