Simple API for scheduling appointments with doctors. Written in Ruby and Sinatra.
Before installing, download and install Ruby.
Database is done in SQLite3. For mac you can install it with brew install sqlite3.
Dependencies are managed with Bundler.
Install gems with bundle install.
Setup database with bundle exec rake db:create.
Migrate the database with bunde exec rake db:migrate.
And seed it bundle exec rake db:seed (WIP)
Or you can run bundle exec rake db:setup to do all of the above.
To run the server, run ruby app in the root directory of the project.
The server will be running on localhost:4567
Here is postman documentation: postman
To use API, you need to create a Organization and know this organization api_key.
You can do this by running rake task bundle exec rake organization:create\[organization_name,organization_email\] you will recive organization api_key.
To authorize You need to make POST request to /exchange_key with email and api_key in body.
In response You will receive access_token that You need to use in all other requests to /api/v1/* in Authorization header.
You can check if Your token is valid by making GET request to /api/v1
Tests are written with RSpec. To run them, run bundle exec rake in the root directory of the project.
If You encounter database errors, run RACK_ENV=test bundle exec rake db:create db:migrate and then run the tests again.
latest coverage report: coverage
This project is licensed under the MIT license.