{
"name": "Vanilla Toffee Bar Crunch",
"image_closed": "/files/live/sites/systemsite/files/flavors/products/us/pint/open-closed-pints/vanilla-toffee-landing.png",
"image_open": "/files/live/sites/systemsite/files/flavors/products/us/pint/open-closed-pints/vanilla-toffee-landing-open.png",
"description": "Vanilla Ice Cream with Fudge-Covered Toffee Pieces",
"story": "Vanilla What Bar Crunch? We gave this flavor a new name to go with the new toffee bars we’re using as part of our commitment to source Fairtrade Certified and non-GMO ingredients. We love it and know you will too!",
"sourcing_values": [
"Non-GMO",
"Cage-Free Eggs",
"Fairtrade",
"Responsibly Sourced Packaging",
"Caring Dairy"
],
"ingredients": [
"cream",
"skim milk",
"liquid sugar",
"water",
"sugar",
"coconut oil",
"egg yolks",
"butter",
"vanilla extract",
"almonds",
"cocoa (processed with alkali)",
"milk",
"soy lecithin",
"cocoa",
"natural flavor",
"salt",
"vegetable oil
"guar gum",
"carrageenan"
],
"allergy_info": "may contain wheat, peanuts and other tree nuts",
"dietary_certifications": "Kosher",
"productId": "646"
}
- Implemented a REST API with CRUD functionality with PosgressSQL as DB
- Authenicated using JWT token
- Documentation done using Swagger ( // Swagger json is not created properly at the time of writing )
- Extensive Testing is done using Post Main, Go Test and manual testing
Table Definition is given below:
Product Table will hold the string fields Ingredients Table will hold ( Product ID, Ingredient ID) SourcingValue Table will hold ( Product ID, Sourcing Value ID) IngredientIndex Table will (Ingredient ID, Value) SourcingValue Table will (Sourcing Value ID, Value)
Efficient Storage and Retrieval of values based on the Values ( Ingredients , Sourcing Values) by keeping in Separate Tables
PreProcess of Values in Ingredients :
"butter (cream","salt)" - Instead of saving 2 values , mapped to Single value in table "butter (cream salt)
"liquid sugar (sugar","water)" - mapped to "liquid sugar (sugar water )
Database Used: Posgress SQL ( Used PostgreSQL as a Service , Elephant SQL ) - DB instance is up and running - Testing is possible by running application locally
Old Values : Array of Ingredients present in DB New Values : Array of Ingredients given to the endpoint
Compare Old Values and New Values :
Make a Decision on Which Values to be Deleted Make a Decision on Which Values to be Inserted Make a Decision on Which Values not touched
Example :
Old Values : "ingredients": [ "cream", "skim milk", "liquid sugar", "water", "sugar", "coconut oil" ]
New Values : "ingredients": [ "cream", "skim milk", "liquid sugar", "water", "black sugar", "coco powder" ]
Rows Untouched during Update : [ "cream" , "skim milk" , "liquid sugar", "water" ]
Rows to be Deleted: [ "sugar", "coconut oil" ]
Rows to be Inserted: ["black sugar", "coco powder" ]
If the indexes are available for black sugar and coco powder in the ingredients index table , update only ingredients table
If the indexs are not available for black sugar and coco powder in the ingredients index table , create entries for black sugar and coco powder in the ingredients table and then update the ingredients table
| Users | Products |
|---|---|
| id | id (PK) |
| name | |
| password | image_open |
| image_close | |
| description | |
| story | |
| allergy_info | |
| dietary_certifications |
| ingredientsindex | sourcingvalueindex |
|---|---|
| id (PK) | id (PK) |
| value (text) | value (text) |
| ingredients | sourcing_values |
|---|---|
| id | id |
| product_id | product_id |
| value_id | value_id |
| PRIMARY KEY (product_id, value_id) | PRIMARY KEY (product_id, value_id) |
| FOREIGN KEY (product_id) REFERENCES products (id) | FOREIGN KEY (product_id) REFERENCES products (id) |
| FOREIGN KEY (value_id) REFERENCES ingredientsindex (id) | FOREIGN KEY (value_id) REFERENCES sourcingvalueindex (id) |
List of APIs supported
[GET] /products
Response : JSON Array
While testing it took 1.5 min to get all the values
[GET] /products/{:id}
Request Parameter : id
Response : JSON element with same structure as example
[POST] /products/{:id}
Request Parameter: id
Request Body : JSON ( with same structure as example) # productID field not supported # new ID generated
Response : JSON { "productID" : value } value - ID of newly created element
[PUT] /products/{:id}
Request Parameter: id
Request Body : JSON ( with same structure as example)
Response: 0 - No change , 1 - Element updated
[DELETE] /products/{:id}
Request Parameter: id
Response: 0 - No change , 1 - Element updated
[GET] /products/{:id}/name
[PUT] /products/{:id"}/name
Request Body: { "name" : value }
[GET] /products/{:id}/image_open
[PUT] /products/{:id"}/image_open
Request Body: { "image_open" : value }
[GET] /products/{:id}/image_closed
[PUT] /products/{:id"}/image_closed
Request Body: { "image_closed" : value }
[GET] /products/{:id}/description
[PUT] /products/{:id"}/description
Request Body: { "description" : value }
[GET] /products/{:id}/story
[PUT] /products/{:id"}/story
Request Body: { "story" : value }
[GET] /products/{:id}/diet
[PUT] /products/{:id"}/diet
Request Body: { "dietary_certifications" : value }
[GET] /products/{:id}/allergy
[PUT] /products/{:id"}/allergy
Request Body: { "allergy_info" : value }
[GET] /products/{:id}/ingredients Response : { "ingredients" : Array of Strings }
[PUT] /products/{:id"}/ingredients
Request Body: { "ingredients" : Array of Strings }
[GET] /products/{:id}/sourcingvalue Response : { "sourcing_value" : Array of Strings }
[PUT] /products/{:id"}/ingredients
Request Body: { "sourcing_value" : Array of Strings }
Using PostMan -- Added postman collection to the zip Using Go Test Manual Testing