Backend Candidate Assessment

Welcome to the Candidate Assessment for Backend developers. We have details instructions on how to get started and what a successful solution will entail. Please read and follow the enclosed instructions.

What are we building?

At the core is our Django API which powers multiple front-facing client(s) - specifically the authentication, CRUD interfaces for models, permissions, and complex workflows.

In our sample application we are adding a webhook /ehr_webhook/ to our API / Platform. Your task is the implementation of the endpoint so that it returns a 201 even if duplicates exist, but returns 400x and 500x for invalid situations (for example malformed json) and ensure the tests are passing and there are no regressions. You will do the work on a separate branch and submit a pull-request (see below for Submit Solution).

Expectations

You can run a local compatible data-store for a Django 4.x app
- Alter settings.py as needed
You can run a local python env with pip
You can handle any build issues that can occur in a python environment
You can run the projects test-suite
Implement a version of the webhook in the 30-1hr time-allotment and be prepared to discuss/document the trade-offs (tech-debit, security, scale-ability)

What We Provide

Setting up a new project is time intensive so we have done some of the upfront work.

We provide you with a shell of a Django app with working migrations, requirements.txt and working tests.
Preconfigured data-store bindings for sqlite and postgres
Sample webhook payloads the assignment/task.
API Documentation
Grading Solution Rubric (see below)

Our Rest API

We also are providing an initial endpoint for you to have as a basis

GET /patient/ will return a list of patients
POST /patient/ - As a POST requires a json body with email, and name as required fields. Returns 201

Assessment Details

You are to implement a new webook endpoint that accepts the following POST /ehr_webhook that will contain an array of data as:

[
  {"email":"pete@example.com", "name": "Pete Townshend"},
  {"email":"Jane@example.com", "name": "Jane Buckneer"}
]

To help you in your work here is an example of our vendors webhook all to our server

curl -X POST -H "Content-Type: application/json"  -d '[{"email":"pete@
fi.com", "name": "Pete Townshend"},{"email":"Jane@example.com", "name": "Jane Buckneer"}]' http://localhost:8000/ehr_webhook/

QuickStart Guide

Here are a few first steps to get off the ground

1. python3 -m venv venv
2. source venv/bin/activate
3. pip install -r requirements.txt
4. python manage.py migrate

At this point you should be able to do either of the following:

Run python manage.py runserver
Run python manage.py test app

What is a Successful Solution

We want to ensure you submit a successful solution so here is our assessment grading rubric.

	Task / Skill-Check	Description
👍	Code Complete	Did you complete the assessment in it's entirety in terms of functionality
✅	CI Passes	We expect the CI Runner using `github-actions` to pass.
📡	API / Network Comms.	Were networking communications properly configured
💭	Pull-Request	Open up a proper PR, *read the submission process below*
	Commit History	We value conventional-commits

Submitting a Solution

1. Setting Up Your Solution

IMPORTANT: When you receive this zip file create your repository and COMMIT the code as the initial commit inside of the default branch main or master.

2. Create a Branch & PR

You should begin to build your solution on a new branch (we don't care what you call it we recommend -- solution). Once you are code complete, create a private repository and push up both branches. And open up a pull-request against the default branch main|master.

3. Finalize & Submit

Invite mgan59, DanOB34, CMitchell08, ramirog89 to your repository so we can see your pull-request. We also recommend assigning the PR to for review so that we get notifications in our github-ui.

4. Review Process

Once the reviewers are added to the repository, we will conduct a quick PR review and setup a time to go over the code together.

Solution

Checklist

Scripts

pipenv install
pipenv shell
pipenv run dev     # python manage.py runserver
pipenv run migrate # python manage.py migrate

Ide setup

Pre-commit

Install pre-commit within .git/hooks/pre-commit.

pre-commit install
pre-commit install --hook-type commit-msg

Supports:

✅ Conventional commits
✅ Trailing and whitespace checks
✅ Check yaml sintax
✅ Check merge conflicts
✅ Prevent debug statements
✅ Check for large files added
✅ Check requirements.txt file to be present
✅ Django: check project for potential problems
✅ Django: check project for missing migrations
✅ Python: flake8
✅ Python: isort
✅ Python: black

VSCode

Suggested configuration file

{
  "files.exclude": {
    "**/.git": true,
    "**/.svn": true,
    "**/.hg": true,
    "**/CVS": true,
    "**/.DS_Store": true,
    "**/*.pyc": true,
    "**/__pycache__": true
  },
  "python.pipenvPath": "<PATH_TO_VENV>", // pipenv --venv
  "python.linting.pylintEnabled": true,
  "python.linting.pylintArgs": [
    "--disable=C0111", // missing docstring
    "--load-plugins=pylint_django"
  ],
  "python.linting.enabled": true,
  "python.formatting.provider": "black"
}

Endpoint

Endpoint: /ehr_webhook/ Allow: POST, OPTIONS Content-Type: application/json Payload

[
    {
        "email": "jane@example.com",
        "name": "Jane Doe"
    },
    {
        "email": "fjcero@gmail.com",
        "name": "Francisco"
    }
]

Specifications

The implementation of the endpoint returns a 201 HTTP Status Code, even if duplicates exist.
HTTP errors like 400x and 500x are triggered in invalid situations, for example malformed json
Tests are passing and there are no regressions
Conventional commits format applied

fjcero / django-take-home