Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 2.4 KB

README.md

File metadata and controls

89 lines (65 loc) · 2.4 KB
Raw

Requriements

You can read the project requirements here

Dependecies

  • PostgreSQL 14.2
  • Ruby 3.1.3

Setting up project locally

Configuring database using Docker

docker pull postgres:14.2
docker volume create working_schedule
docker container create --name working_schedule --publish 5432:5432 --env POSTGRES_USER=postgres --env POSTGRES_PASSWORD=password --volume working_schedule:/var/lib/postgresql/data postgres:14.2
docker start working_schedule

Setting ENV variables

cp .env.example .env

Preparing databases

bin/rake db:create db:schema:load

Checking tests, Rubocop and Zeitwerk

bin/rails test
bin/rubocop
bin/rails zeitwerk:check

Project Structure

The project uses gem Grape to build a REST gateway.

app/gateways # Entry point, should contain supported gateways REST, GraphQL and etc
└── rest # The folder for the REST gateway
    ├── api # API Endpoints
    ├── api.rb # API Endpoints entry point
    ├── serialization # Response data serialization
    ├── services # Operations specific for the REST gateways
    └── validation # Endpoints request validations
    
app/models # Main entities
├── admin.rb # Super user with access to all the operations
├── authentication.rb # Credentials store
├── organization.rb # An entity for grouping workers
├── shift.rb
└── worker.rb

app/policies # Project policies

app/operations # Domain operations that are independent from any gateway

Exploring API

Since the project is based on Grape it can generate "some" Swagger-compatible documentation for no cost. To get all the possible endpoints:

  1. Start your local server
  2. Visit /api/swagger
  3. Grab the response JSON
  4. Paste it into the swagger redactor on

NOTE The swagger documentation contains only the endpoints WITHOUT the input parameters and the response type. The input parameters are described by validation contracts in every endpoint. The output parameters are represent by gateway serializers.

Even though, the project has a comprehensive policy layer, the easiest way of accessing endpoints is using admin credentials. Just run the following command and put its output to Authorization header in your REST API Client.

ADMIN_USERNAME=admin ADMIN_PASSWORD=password bin/rake admin:create