LemonadePartnerAPi

Take home interview assignment from 8/31/2021 to be returned on 9/7/2021 to Lemonade.

Additional documentation available: API.yaml, Postman Sample Collection, Presentation.

I am using two local DynamoDB tables to store data. One table is used for Quotes and the other for Policies. This approach has numerous advantages over an array. A single endpoint looks at the type of id provided and makes a request to the correct table. Checkout the Setup section of this document to install DynamoDB on your local. I've included a .db file with some preloaded data.

Features

• User can provide a "QuoteInput" object to store a "Quote" in a Dynamo Table ("QuotesTable")

• User can query both "QuotesTable" and "PoliciesTable" for individual records given matching IDs

• User can make a request to return all records in both "QuotesTable" and "PoliciesTable"

• User can create a "PaymentConfirmation" object given a valid quoteID

• If correctly formatted "mortgageID" is provided then a paymentConfirmation will be returned with the ID of the mortgageID

• If no "mortgageID" is provided a stripeCheckoutSession will be created with the ID of the mortgageID

• In order to proceed to creating a policy the stripe session token must be marked as "PAID"

• User can provide a valid "PaymentConfirmation" containing either a mortgageID or valid stripe session token to create a policy

• User may only create policies for quotes that are in the "READY" status

• QuoteID stored on the payment confirmation MUST match the given quoteID

• User can delete both Quotes and Policies given the correct ID

• User can update both Quotes and Policies given the correct ID

Setup

clone this repo on into your local machine

git clone https://github.com/Dev-Drew/LemonadeAPI.git

Use the package manager npm to install all required dependencies for LemonadePartnerAPI.

npm install

This project uses two AWS local Dynamo DB Tables to perform CRUD operations. You will need install Dynamo DB on your local machine. It's pretty straightforward and AWS has great documentation

Once Dynamo is installed you will need to create both tables on your local machine. I have provided two files for that will create them. Navigate to src/dynamo/createScripts then run the following commands

node createPolicyTable.js

node createQuoteTable.js

Once the tables are created you will need to create an .env file at project root. Create the file then copy over what I've included in .env.example.

A stripe secret key can be generated through stripe's website. If you're having a hard time, check out this guide.

To send and receive emails this project has been configured with mailtrap. A mailtrap userID and password is required, these can be retrieved from the mailtrap website.

Your .env file should look something like this when complete

STRIPE_TEST_KEY=sk_test_51JVNu0LvFtdDa1wmNLgNXZy3whQzCa7ojb3DG8aMEWmxfwNCXTlz2yWvp27aRQLQFL0pFecfJol7kPvo87DWlrZC00kO6GJOhM

MAILTRAP_USER=2a798c947a2e44

MAILTRAP_PASS=8eb3c831254244

Great! We're done.

All that's left is to start the server. I've included a few different run scripts in the package.json.

My favorite for development is start:dev.

npm run start:dev

Assumptions

From Requirements

• Premium is always $500

• Stripe is used to process payment if mortgage ID is not provided

• No UI is required

• No deployment infrastructure is needed

• Quotes and Policies will only be for Home insurance

Personal

• QuoteIDs will be random 15 characters start with "LQ"

• MortgageIDs will be random 15 characters start with "MID"

• Any 15 character MortgageID string will be valid if it starts with "MID"

• PolicyIDs will be random 15 characters start with "LP"

• User is always fully authenticated and authorized

• One quote is only good to create one policy (can not use the same quoteID to create multiple polices)

• Additional libraries / frameworks are allowed

• No requirement for test coverage

Usage

Take a look at the api.yaml file I've included with the project to see what type of requests you can make.

Basic Flow

1. Create a Quote using a "QuoteInput"

2. Retrieve that Quote using its ID

3. Create a payment confirmation using the ID of the quote

3.1 Only providing an ID will attempt checkout through Stripe. You may include any valid mortgageID if you want to bypass Stripe ( "mortgageID": "MID163084932900")

4. Create a policy using the ID on the "PaymentConfirmation" from step 3

5. Retrieve that Policy using the ID from step 4

Read all that and got no idea where to start? I've included a postman collection in the documents folder that has all the requests.

Tech Stack

Few Basics:

Typescript: Primary Language

Node.js: Runtime

Prettier: Formatter

ESLint: Syntax

---

More Advanced:

NestJS: Node.js Framework, that makes building webservices a lot faster and easier (in my opinion). It draws a lot from Angular. I really like the way it handles routing and decorators. By default NestJS uses express, but for improved performance I've opted for Fastify

Stripe: Project requirement. Great dashboards and documentation. I've only enabled test mode, but I can still see transactions on my test dashboard.

Nestjs-stripe: Basically a wrapper for stripe's own module.

Open: Small module I'm using to open the stripe checkout session. Super easy.

DynamoDB: Database, super powerful and easy to scale. I'm only using the local version in this project.

AWS Javacsript SDK Used to access Dynamo table. I've opted to use DocumentClient to handle all my access. It's pretty high level and abstracts a lot away.

nest-modules/mailer: Wrapper around Nodemailer. Easy way to send out emails, provided your email sever allows you.

mailtrap: Email Sandbox, really cool app that allows you to send and receive emails. I was hesitant to put up my personal info in plaintext. We can view sent emails via the mailtrap UI.

---

Local Tools:

VSCode: IDE

DB Browser: GUI to view records in my local DB

Postman: Send HTTP Requests

Contributing

Will be turning this repo private once the process is over, but feel free to reach out if you have any questions!

License

MIT