Inital - base Adonis with Lucid and inital tests

Author: vicainelli

.adonisrc.json

@@ -0,0 +1,29 @@
+{
+  "typescript": true,
+  "commands": [
+    "./commands",
+    "@adonisjs/core/build/commands",
+    "@adonisjs/repl/build/commands",
+    "@adonisjs/lucid/build/commands"
+  ],
+  "exceptionHandlerNamespace": "App/Exceptions/Handler",
+  "aliases": {
+    "App": "app",
+    "Config": "config",
+    "Database": "database",
+    "Contracts": "contracts"
+  },
+  "preloads": [
+    "./start/routes",
+    "./start/kernel"
+  ],
+  "providers": [
+    "./providers/AppProvider",
+    "@adonisjs/core",
+    "@adonisjs/lucid",
+    "@adonisjs/auth"
+  ],
+  "aceProviders": [
+    "@adonisjs/repl"
+  ]
+}

.editorconfig

@@ -0,0 +1,14 @@
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.json]
+insert_final_newline = ignore
+
+[*.md]
+trim_trailing_whitespace = false

.env.example

@@ -0,0 +1,11 @@
+PORT=
+HOST=
+NODE_ENV=
+APP_KEY=
+DB_CONNECTION=mysql
+MYSQL_HOST=localhost
+MYSQL_PORT=3307
+MYSQL_USER=adonisjs
+MYSQL_PASSWORD=secret
+MYSQL_DB_NAME=adonisjs
+MYSQL_ALLOW_EMPTY_PASSWORD=true

.env.testing

@@ -0,0 +1,6 @@
+PORT=3333
+HOST=0.0.0.0
+NODE_ENV=testing
+APP_KEY=UDMP4faE9vPtVd718Dg8nFAY_Pv_QU3n
+DB_CONNECTION=sqlite
+

.eslintignore

@@ -0,0 +1 @@
+build

.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["plugin:adonis/typescriptApp", "prettier", "prettier/@typescript-eslint"],
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": ["error"]
+  }
+}

.gitignore

@@ -0,0 +1,8 @@
+node_modules
+build
+coverage
+.vscode
+.DS_STORE
+.env
+tmp
+.idea

.prettierignore

@@ -0,0 +1 @@
+build

.prettierrc

@@ -0,0 +1,10 @@
+{
+  "trailingComma": "es5",
+  "semi": false,
+  "singleQuote": true,
+  "useTabs": false,
+  "quoteProps": "consistent",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "printWidth": 100
+}

README.md

@@ -0,0 +1,38 @@
+# NodeJS Scaffold API with AdonisJS 5
+
+## Requirements
+
+- Node.js >= 12.0.0
+- npm >= 6.0.0
+
+And if you don't have a database installed, you can user a Docker container.
+
+
+## Set It Up
+
+#### 1. Install node dependencies
+
+```
+npm install
+```
+
+#### 2. Create the .env file
+```
+cp .env.example .env
+```
+
+#### 4. Set up docker
+```
+docker-compose build && docker-compose up -d
+```
+
+#### 5. Run the migrations
+
+```
+node ace migrations:run
+```
+
+#### 6. Start and watch the serve
+```
+node ace serve --watch
+```

__tests__/functional/Login.spec.ts

@@ -0,0 +1,46 @@
+import { UserFactory } from 'Database/factories'
+import test from 'japa'
+import supertest from 'supertest'
+
+const BASE_URL = `http://${process.env.HOST}:${process.env.PORT}`
+
+test.group('AuthController - Login', () => {
+  test('should login with right credentials ', async (assert) => {
+    const sessionPayload = {
+      password: 'secret',
+    }
+    const user = await UserFactory.merge({ ...sessionPayload }).create()
+
+    const result = await supertest(BASE_URL)
+      .post('/login')
+      .send({
+        email: user.email,
+        ...sessionPayload,
+      })
+      .set('Accept', 'application/json')
+      .expect(200)
+    assert.exists(result.body)
+    assert.exists(result.body.token)
+  })
+
+  test('should not login with wrong credentials ', async (assert) => {
+    const sessionPayload = {
+      password: 'secret',
+    }
+
+    const user = await UserFactory.create()
+
+    const result = await supertest(BASE_URL)
+      .post('/login')
+      .send({
+        email: user.email,
+        ...sessionPayload,
+      })
+      .set('Accept', 'application/json')
+      .expect(400)
+
+    assert.exists(result.body)
+    assert.exists(result.body.errors)
+    assert.equal(result.body.errors[0].message, 'Invalid user credentials')
+  })
+})

__tests__/functional/Register.spec.ts

@@ -0,0 +1,70 @@
+import test from 'japa'
+import supertest from 'supertest'
+
+const BASE_URL = `http://${process.env.HOST}:${process.env.PORT}`
+
+test.group('AuthController - Register', () => {
+  test('should create a new user with the right data', async (assert) => {
+    const result = await supertest(BASE_URL)
+      .post('/register')
+      .send({
+        email: 'vini@nodejs.com',
+        password: 'secret',
+        password_confirmation: 'secret',
+      })
+      .set('Accept', 'application/json')
+      .expect(201)
+
+    assert.exists(result.body)
+    assert.equal(result.body.email, 'vini@nodejs.com')
+  })
+
+  test('should not create a new user with an exist email ', async (assert) => {
+    const result = await supertest(BASE_URL)
+      .post('/register')
+      .send({
+        email: 'vini@nodejs.com',
+        password: 'secret',
+        password_confirmation: 'secret',
+      })
+      .set('Accept', 'application/json')
+      .expect('Content-Type', /json/)
+      .expect(422)
+
+    assert.exists(result.body)
+    assert.equal(result.body.errors[0].rule, 'unique')
+    assert.equal(result.body.errors[0].field, 'email')
+    assert.equal(result.body.errors[0].message, 'unique validation failure')
+  })
+
+  test('should not create a new user without a password ', async (assert) => {
+    const result = await supertest(BASE_URL)
+      .post('/register')
+      .send({
+        email: 'vini-2@nodejs.com',
+      })
+      .set('Accept', 'application/json')
+      .expect(422)
+
+    assert.exists(result.body)
+    assert.equal(result.body.errors[0].rule, 'required')
+    assert.equal(result.body.errors[0].field, 'password')
+    assert.equal(result.body.errors[0].message, 'required validation failed')
+  })
+
+  test('should not create a new user without a confirmation password ', async (assert) => {
+    const result = await supertest(BASE_URL)
+      .post('/register')
+      .send({
+        email: 'vini-2@nodejs.com',
+        password: 'secret',
+      })
+      .set('Accept', 'application/json')
+      .expect(422)
+
+    assert.exists(result.body)
+    assert.equal(result.body.errors[0].rule, 'confirmed')
+    assert.equal(result.body.errors[0].field, 'password_confirmation')
+    assert.equal(result.body.errors[0].message, 'confirmed validation failed')
+  })
+})

ace

@@ -0,0 +1,16 @@
+/*
+|--------------------------------------------------------------------------
+| Ace Commands
+|--------------------------------------------------------------------------
+|
+| This file is the entry point for running ace commands.
+|
+*/
+
+require('reflect-metadata')
+require('source-map-support').install({ handleUncaughtExceptions: false })
+
+const { Ignitor } = require('@adonisjs/core/build/standalone')
+new Ignitor(__dirname)
+  .ace()
+  .handle(process.argv.slice(2))

ace-manifest.json

@@ -0,0 +1 @@
+{"dump:rcfile":{"settings":{},"commandPath":"@adonisjs/core/build/commands/DumpRc","commandName":"dump:rcfile","description":"Dump contents of .adonisrc.json file along with defaults","args":[],"flags":[]},"list:routes":{"settings":{"loadApp":true},"commandPath":"@adonisjs/core/build/commands/ListRoutes","commandName":"list:routes","description":"List application routes","args":[],"flags":[{"name":"json","propertyName":"json","type":"boolean","description":"Output as JSON"}]},"generate:key":{"settings":{},"commandPath":"@adonisjs/core/build/commands/GenerateKey","commandName":"generate:key","description":"Generate a new APP_KEY secret","args":[],"flags":[]},"repl":{"settings":{"loadApp":true,"environment":"repl","stayAlive":true},"commandPath":"@adonisjs/repl/build/commands/AdonisRepl","commandName":"repl","description":"Start a new REPL session","args":[],"flags":[]},"db:seed":{"settings":{"loadApp":true},"commandPath":"@adonisjs/lucid/build/commands/DbSeed","commandName":"db:seed","description":"Execute database seeder files","args":[],"flags":[{"name":"connection","propertyName":"connection","type":"string","description":"Define a custom database connection for the seeders","alias":"c"},{"name":"interactive","propertyName":"interactive","type":"boolean","description":"Run seeders in interactive mode","alias":"i"},{"name":"files","propertyName":"files","type":"array","description":"Define a custom set of seeders files names to run","alias":"f"}]},"make:model":{"settings":{},"commandPath":"@adonisjs/lucid/build/commands/MakeModel","commandName":"make:model","description":"Make a new Lucid model","args":[{"type":"string","propertyName":"name","name":"name","required":true,"description":"Name of the model class"}],"flags":[{"name":"migration","propertyName":"migration","type":"boolean","alias":"m","description":"Generate the migration for the model"},{"name":"controller","propertyName":"controller","type":"boolean","alias":"c","description":"Generate the controller for the model"}]},"make:migration":{"settings":{"loadApp":true},"commandPath":"@adonisjs/lucid/build/commands/MakeMigration","commandName":"make:migration","description":"Make a new migration file","args":[{"type":"string","propertyName":"name","name":"name","required":true,"description":"Name of the migration file"}],"flags":[{"name":"connection","propertyName":"connection","type":"string","description":"Define a custom database connection for the migration"},{"name":"folder","propertyName":"folder","type":"string","description":"Pre-select a migration directory"},{"name":"create","propertyName":"create","type":"string","description":"Define the table name for creating a new table"},{"name":"table","propertyName":"table","type":"string","description":"Define the table name for altering an existing table"}]},"make:seeder":{"settings":{},"commandPath":"@adonisjs/lucid/build/commands/MakeSeeder","commandName":"make:seeder","description":"Make a new Seeder file","args":[{"type":"string","propertyName":"name","name":"name","required":true,"description":"Name of the seeder class"}],"flags":[]},"migration:run":{"settings":{"loadApp":true},"commandPath":"@adonisjs/lucid/build/commands/Migration/Run","commandName":"migration:run","description":"Run pending migrations","args":[],"flags":[{"name":"connection","propertyName":"connection","type":"string","description":"Define a custom database connection","alias":"c"},{"name":"force","propertyName":"force","type":"boolean","description":"Explicitly force to run migrations in production"},{"name":"dry-run","propertyName":"dryRun","type":"boolean","description":"Print SQL queries, instead of running the migrations"}]},"migration:rollback":{"settings":{"loadApp":true},"commandPath":"@adonisjs/lucid/build/commands/Migration/Rollback","commandName":"migration:rollback","description":"Rollback migrations to a given batch number","args":[],"flags":[{"name":"connection","propertyName":"connection","type":"string","description":"Define a custom database connection","alias":"c"},{"name":"force","propertyName":"force","type":"boolean","description":"Explictly force to run migrations in production"},{"name":"dry-run","propertyName":"dryRun","type":"boolean","description":"Print SQL queries, instead of running the migrations"},{"name":"batch","propertyName":"batch","type":"number","description":"Define custom batch number for rollback. Use 0 to rollback to initial state"}]},"migration:status":{"settings":{"loadApp":true},"commandPath":"@adonisjs/lucid/build/commands/Migration/Status","commandName":"migration:status","description":"Check migrations current status.","args":[],"flags":[{"name":"connection","propertyName":"connection","type":"string","description":"Define a custom database connection","alias":"c"}]}}

app/Controllers/Http/AuthController.ts

@@ -0,0 +1,20 @@
+import User from 'App/Models/User'
+import RegisterValidator from 'App/Validators/User/RegisterValidator'
+import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
+
+export default class AuthController {
+  public async register({ request, response }: HttpContextContract) {
+    const { email, password } = await request.validate(RegisterValidator)
+
+    const user = await User.create({ email, password})
+
+    return response.created(user)
+  }
+  public async login({ request, auth }: HttpContextContract) {
+    const email = request.input('email')
+    const password = request.input('password')
+
+    const token = await auth.use('api').attempt(email, password)
+    return token.toJSON()
+  }
+}

app/Exceptions/Handler.ts

@@ -0,0 +1,23 @@
+/*
+|--------------------------------------------------------------------------
+| Http Exception Handler
+|--------------------------------------------------------------------------
+|
+| AdonisJs will forward all exceptions occurred during an HTTP request to
+| the following class. You can learn more about exception handling by
+| reading docs.
+|
+| The exception handler extends a base `HttpExceptionHandler` which is not
+| mandatory, however it can do lot of heavy lifting to handle the errors
+| properly.
+|
+*/
+
+import Logger from '@ioc:Adonis/Core/Logger'
+import HttpExceptionHandler from '@ioc:Adonis/Core/HttpExceptionHandler'
+
+export default class ExceptionHandler extends HttpExceptionHandler {
+  constructor() {
+    super(Logger)
+  }
+}

app/Middleware/Auth.ts

@@ -0,0 +1,71 @@
+import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
+import { AuthenticationException } from '@adonisjs/auth/build/standalone'
+
+/**
+ * Auth middleware is meant to restrict un-authenticated access to a given route
+ * or a group of routes.
+ *
+ * You must register this middleware inside `start/kernel.ts` file under the list
+ * of named middleware.
+ */
+export default class AuthMiddleware {
+  /**
+  * The URL to redirect to when request is Unauthorized
+  */
+  protected redirectTo = '/login'
+
+  /**
+   * Authenticates the current HTTP request against a custom set of defined
+   * guards.
+   *
+   * The authentication loop stops as soon as the user is authenticated using any
+   * of the mentioned guards and that guard will be used by the rest of the code
+   * during the current request.
+   */
+  protected async authenticate (auth: HttpContextContract['auth'], guards: any[]) {
+    /**
+     * Hold reference to the guard last attempted within the for loop. We pass
+     * the reference of the guard to the "AuthenticationException", so that
+     * it can decide the correct response behavior based upon the guard
+     * driver
+     */
+    let guardLastAttempted: string | undefined
+
+    for (let guard of guards) {
+      guardLastAttempted = guard
+
+      if (await auth.use(guard).check()) {
+        /**
+         * Instruct auth to use the given guard as the default guard for
+         * the rest of the request, since the user authenticated
+         * succeeded here
+         */
+        auth.defaultGuard = guard
+        return true
+      }
+    }
+
+    /**
+     * Unable to authenticate using any guard
+     */
+    throw new AuthenticationException(
+      'Unauthorized access',
+      'E_UNAUTHORIZED_ACCESS',
+      guardLastAttempted,
+      this.redirectTo,
+    )
+  }
+
+  /**
+   * Handle request
+   */
+  public async handle ({ auth }: HttpContextContract, next: () => Promise<void>, customGuards: string[]) {
+    /**
+     * Uses the user defined guards or the default guard mentioned in
+     * the config file
+     */
+    const guards = customGuards.length ? customGuards : [auth.name]
+    await this.authenticate(auth, guards)
+    await next()
+  }
+}