Introduction

This project is just a showcase for a chat system that is intended to work as a microservice in between multiple services.

Environment

• Ruby 3.1.2
• Rails (API only) 7.0.3
• Mysql
• Redis server 7.0.4
• Elasticsearch
• Sidekiq

Getting started

1. Install docker which includes docker-compose from https://docs.docker.com/engine/install/ (if not installed)

2. Clone the project's main branch:

   [email protected]:abdulashref333/Instabug-Task.git

3. Head to the project root directory cd Instabug-Task

4. NOTE: For Windows users you will need to convert docker/entrypoint.sh file line break type from CRLF to LF.

5. Copy .env.example to .env.

   cp docker/.env.example .env

6. Replace APP_USER_ID value in .env with your user ID

   sed  -i "/APP_USER_ID=/c\APP_USER_ID=$(id -u)" .env

7. Create project docker network

   docker network create instabug_task_private_network

8. Run docker compose up

You can now visit http://localhost:3000/

9. To open sidekiq dashboard http://127.0.0.1:3000/sidekiq

10. To run the test specs

    1. docker exec -it instabug_task bash # this will open a bash session inside the container
    2. rspec # this will run the specs files.

API-Endpoints

• root path: /api/v1

Method	Endpoint	Description	Request Body
POST	/applications	Create new application	{"name": "application #1"}
GET	/applications/:token	Get application data
PATCH	/applications/:token	Update application name	{"name": "application #2"}
--------
POST	/applications/:token/chats	Create new chat	{}
GET	/applications/:token/chats	Get List of chats for specific application
GET	/applications/:token/chats/:number	Get chat data
--------
POST	/applications/:token/chats/:number/messages	Add new message to specific chat	{"body": "test message body #2"}
GET	/applications/:token/chats/:number/messages	Get List of messages for specific chat
GET	/applications/:token/chats/:number/messages/search	Search in chat message
GET	/applications/:token/chats/:number/messages/:message_number	Get message data
PATCH	/applications/:token/chats/:number/messages/:message_number	Update message data(body)	{"body": "test message body #3"}

• Example of a full endpoint: POST: http://localhost:3000/api/v1/applications

Specs

1. Create Applications each with a unique token
2. Upadate Applications
3. Retrieve Application by token
4. Create Chats entities for each application each with a unique number(started from 1,2,3,...)
5. List Chats that are in each application
6. Get specific chat in application by the application token & and chat number
7. Create messages for each chat in application
8. Update message
9. List messages in each chat
10. Search in messages which in a specific chat
11. No Id's are returned back for any of the three entities(Application, Chat, Message)
12. Specs file for each Model, Job, Controller.

TO-DO

1. Add ovvercommit gem