DOCUMENTATION

Technical stuff

• Ruby Version: ruby 2.4.0
• Rails Version: Rails 5.1.1
• RVM: Ruby enVironment Manager 1.29.1

Gems used

• devise_token_auth
• cancancan
• firebase
• rspec

Entity Relationship Diagram

Endpoints

Swagger is not configured to reach the endpoints properly, just use it as a guide to know which endpoints are available and the structure for those.

Things to consider

• There is only one admin user: email: [email protected] password: 12345678
• The headers follow the RFC 6750 Bearer Token format. You need to pass to each request 5 headers:
• Every response will provide a new token and expiry which you should use for the next request.
• You have the ability to associate multiple organizations registering a new user (By default it will be a regular user), to do that you should pass:

Things to improve

• Implement some representer pattern through a gem like ROAR or any similar, you will see null values in the properties in the response if they are not set.