Rentx

Allows users to register yourself, manage his token, reset passwords, see his own profile, update his avatar, create cars and set specification and categories to it, import a bulk of categories at once, see available cars for rent, attach cars'images, rent a car, see previous rents and make a car devolution. The app has rate limit, friendly errors, use JWT to logins, validation, also a simple versioning was made.

Table of Contents

• Installing
  • Configuring
    • Redis
    • Postgres
      • Migrations
    • .env
    • Rate Limit (Optional)
• Usage
  • Error Handling
    • Errors Reference
  • Bearer Token
  • Versioning
  • Routes
    • Requests
• Running the tests
  • Coverage report

Installing

Easy peasy lemon squeezy:

$ yarn

Or:

$ npm install

Was installed and configured the eslint and prettier to keep the code clean and patterned.

Configuring

The application uses two databases: Postgres and Redis. For the fastest setup is recommended to use docker-compose, you just need to up all services:

$ docker-compose up -d

Redis

Responsible to store data utilized by the rate limit middleware. If for any reason you would like to create a Redis container instead of use docker-compose, you can do it by running the following command:

$ docker run --name rentx-redis -d -p 6379:6379 redis:alpine

Postgres

Responsible to store all application data. If for any reason you would like to create a MongoDB container instead of use docker-compose, you can do it by running the following command:

$ docker run --name rentx-postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

Then create two databases: rentx and test (in case you would like to run the tests).

Migrations

Remember to run the database migrations:

$ yarn ts-node-dev ./node_modules/typeorm/cli.js migration:run

Or:

$ yarn typeorm migration:run

See more information on TypeORM Migrations.

.env

In this file you may configure your Redis and Postgres database connection, JWT settings, the environment, app's port, mail and storage driver, aws settings (case be necessary) and a url to documentation (this will be returned with error responses, see error section). Rename the .env.example in the root directory to .env then just update with your settings.

Rate Limit (Optional)

The project comes pre-configured, but you can adjust it as your needs.

• src/config/rateLimit.ts

The lib rate-limiter-flexible was used to rate the api's limits, for more configuration information go to Options page.

Usage

To start up the app run:

$ yarn dev:server

Or:

npm run dev:server

Error Handling

Instead of only throw a simple message and HTTP Status Code this API return friendly errors:

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too Many Requests",
  "code": 749,
  "docs": "https://github.com/DiegoVictor/rentx#errors-reference"
}

As you can see a url to error docs are returned too. To configure this url update the DOCS_URL key from .env file. In the next sub section (Errors Reference) you can see the errors code description.

Errors Reference

Bearer Token

A few routes expect a Bearer Token in an Authorization header.

You can see these routes in the routes section.

GET http://localhost:3333/v1/rentals Authorization: Bearer <token>

To achieve this token you just need authenticate through the /sessions route and it will return the token key with a valid Bearer Token.

Versioning

A simple versioning was made. Just remember to set after the host the /v1/ string to your requests.

GET http://localhost:3333/v1/rentals

Routes

Routes with Bearer as auth method expect an Authorization header. See Bearer Token section for more information.

Requests

• POST /session

Request body:

{
  "email": "[email protected]",
  "password": "123456"
}

• POST /refresh_token

Request body:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
}

• POST /cars

Request body:

{
  "name": "Car name",
  "description": "Car description",
  "daily_rate": 140.0,
  "license_plate": "XYZ1234",
  "fine_amount": 100,
  "brand": "Car brand",
  "category_id": "6878f9b2-eb7c-4ad6-ac72-66d958f117c2"
}

• POST /cars/:id/specifications

Request body:

{
  "specifications_id": ["b3267e11-eec4-46a4-accc-9e8b4fad0af7"]
}

• POST /cars/:id/images Image file(s)

• POST /categories

Request body:

{
  "name": "Category name",
  "description": "Category description"
}

• POST /categories/import CSV file

• POST /password/forgot

Request body:

{
  "email": "[email protected]"
}

• POST /password/reset

Request body:

{
  "password": "123456"
}

• POST /rentals

Request body:

{
  "expected_return_date": "2021-04-08T01:31:15.328Z",
  "car_id": "01931fee-32d4-4af7-b4e9-12159c5d703e"
}

• POST /specifications

Request body:

{
  "name": "Specification name",
  "description": "Specification description"
}

• POST /users

Request body:

{
  "name": "John",
  "email": "[email protected]",
  "password": "123456",
  "driver_license": "782378234923"
}

• PATCH /users/avatar
  Image file

Running the tests

Jest was the choice to test the app, to run:

$ yarn test

Or:

$ npm run test

Coverage report

You can see the coverage report inside tests/coverage. They are automatically created after the tests run.