bundleUP API

FRONT END REPO: https://github.com/cathyob/bundleUP

DEPLOYED FRONT END: https://cathyob.github.io/bundleUP/

BACK END REPO: https://github.com/cathyob/bundleUpServer

DEPLOYED BACK END: https://bundleupcathyob.herokuapp.com/

Endpoints

User:

• Create - sign up - POST - /sign-up
• Read - sign in - POST - /sign-in/:id
• Update - change password - PUT - /user/:id
• Update - save last valid location search - PUT -/user/:id
• Update - sign out - DELETE - /sign-out/:id

Log:

• Create - new entry - POST - /log
• Read - see past entries - GET - /log/:id
• Read - see average of entries (used to generate custom message) - GET - /log
• Update - edit past entry - PUT - /log/:id
• Delete - remove past entry - DELETE - /log/:id

ERD

Dependencies/Technologies

This API uses MongoDB, Mongoose, Express along with a Heroku deployed backend server.

I've also hooked up two 3rd party APIs - Google for translating a zipcode into latitude/longitude and Dark Sky for retrieving weather data for that location.

My inital designs could have been applied to an SQL or NoSQL structure and my future plans for the app did not impact either version so I decided to use a Mongo/Express API to practice NoSQL.

A User document contains subdocuments of Logs. Each Log contains:

• date_time: { type: Date, default: Date.now, },
• location: { type: String, required: true, },
• temp: { type: Number, integer: true, },
• feels_like: { type: Number, integer: true, required: true, },
• weather_conditions: { type: String, required: true, },
• bottom_layers: { type: String, default: '', },
• top_layers: { type: String, default: '', },
• accessories: { type: String, default: '', },
• activity_level: { type: Number, integer: true, required: true, min: 1, max: 5, },
• comfort_level: { type: Number, integer: true, required: true, min: 1, max: 5, },

For the integers, I installed mongoose-integer: https://www.npmjs.com/package/mongoose-integer It worked perfectly for what I needed.

Approach

I decided to have the dateTime default to the time the report is created. Also, the feelsLike detail is required since that will be what I will base returning the most recent, similar days to a customized message shown to a signed in user.

Also, for the layers fields, I made them each default to an empty string so that if the user leaves them blank it won't return null.

Testing and Hurdles

As part of the set-up of this file, I found and addressed two shortcomings within the users controller:

1. On sign-up it did not check to see if the second password entry matched the first. I added a ternary to ensure they matched. ga-wdi-boston/express-api-template-ARCHIVED#39
2. On change password it did not recognize an empty new password as an error. I updated it to ensure it was not an empty string. ga-wdi-boston/express-api-template-ARCHIVED#50

Before deployment I made sure to create curl scripts in order to test my log endpoints. I was able to create working curl scripts for all routes.

I added two 3rd party APIs to this repo - Google Maps Geocoding for latitute/logitude from a zip code and Dark Sky for the weather data based on that location. I filed an issue since this was the first time I'd used a 3rd party API in my own API and posted what I did here: ga-wdi-boston/capstone-project#530

Thank you!

Thank you very much for checking out my app! Please be sure to try it out and let me know if you have any questions! https://cathyob.github.io/bundleUP/