Invoice API

Building an API using Ruby on Rails 6 and authentication with devise token auth.

Ruby Version	2.5.8
Rails Version	6.0.4.6
Database	PostgreSQL

Installation

  # clone the project
  git clone git@github.com:karinevieira/invoice-api.git

  # enter the cloned directory
  cd invoice-api

  # run the project
  docker-compose up --build

  # create the development and test databases
  rails db:create

  # migrate tables to database
  rails db:migrate
  rails db:migrate RAILS_ENV=test

Open the browser at the address http://localhost:3000

Running Tests

To run tests, run the following command

  rspec

API Reference

Include Headers

Include the headers:

  uid: 'userEmail'
  client: 'userClient'
  access-token: 'UserAccessToken'

For the follow requests:

• Logout
• Edit user
• Edit the user password
• Delete user
• Create bill
• Edit bill
• Delete bill

Endpoints

Endpoints	Usage	Params
POST /api/auth	Create a new user.	email: [String], password: [String], password_confirmation: [String]
PUT /api/auth	Edit the user information.	name: [String], nickname: [String], email: [String]
PUT /api/auth	Edit the user password.	current_password: [String], password: [String], password_confirmation: [String]
POST /api/auth	Forgot the user password.	email: [String]
DELETE /api/auth	Remove the user.
POST /api/auth/sign_in	Login user's session.	email: [String], password: [String]
DELETE /api/auth/sign_out	Logout user's session.
GET /api/bills	Get all of the bills.
GET /api/bills/:id	Get details of a single bill.
POST /api/bills	Create a new bill.	due_date: [String], description: [String]
PUT /api/bills/:id	Edit the details of an existing bill.	due_date: [String], description: [String]
DELETE /api/bills/:id	Remove the bill.

Usage

To create or edit a bill

{
	"due_date": "2022-05-07",
	"description": "Keyboard sale",
	"bill_items_attributes": [
		{
			"name": "GAMER T-DAGGER MECHANICAL KEYBOARD",
			"quantity": "1",
			"price": "249.50",
			"total": "249.50"
		}
	],
	"customer_attributes": {
		"name": "Karine Vieira",
		"cpf": "964.775.040-49",
		"phone": "(11) 79657-5709"
	}
}