Teapot is a python-django based application wrapped in docker-compose which calculates discounts for orders.
- A simple REST-API which can be easely used in class based views
- Unit-tests
- Admin interface
git clone https://github.com/jroeland/teapot.git
Note: Tested only in linux-debian based distributions.
Requirements:
- pip
It is possible to runproject without having to use docker-compose. Simply edit the following file:
/project/web/app/website/settings.py
Change the following variables:
TEST = True
STATIC_ROOT = '/<path>/<to>/<repo>/app/static'
Run the following file, which will install the requirements using pip, run the migrations and load the initial data.
Note: Its recommended to run this command in a virttual env, although it will still work if ran globally:
cd project/
. /easy_build.sh
Now start the django's development server:
cd project/web/app/
python manage.py runserver localhost:8000
Surf to http://localhost:8000/admin/ If you can see the admin interface. The install was successful
To run the tests, run:
cd project/web/app/
python manage.py test
The service will be running in port 8000.
To change this, edit the file project/docker-compose.yml
To build the project as a micro-service:
cd project/
. build.sh
Surf to http://localhost:8000/admin/ If you can see the admin interface. The install was successful
If you have made some changes to the docker file or docker-compose and you wish to re-build the service:
cd project/
. rebuildAll.sh
To stop the service:
cd project/
. stop.sh
To start / restart the service:
cd project/
. start.sh
To run the tests:
cd project/
. runTests.sh
The end-points for customers:
http://localhoct:8000/api/customers/ accepts GET, POST requests
http://localhoct:8000/api/customers/\<id\>/ accepts GET, PUT and DELETE requests
The end-points for products:
http://localhoct:8000/api/products/ accepts GET, POST requests
http://localhoct:8000/api/products/\<id\>/ accepts GET, PUT and DELETE requests
The end-points for product categories:
http://localhoct:8000/api/products/categories/ accepts GET, POST requests
http://localhoct:8000/api/products/categories/\<id\>/ accepts GET, PUT and DELETE requests
The end-points for free product discounts:
http://localhoct:8000/api/discounts/freeproducts/ accepts GET, POST requests
http://localhoct:8000/api/discounts/freeproducts/\<id\>/ accepts GET, PUT and DELETE requests
The end-points for category discounts:
http://localhoct:8000/api/discounts/categories/ accepts GET, POST requests
http://localhoct:8000/api/discounts/categories/\<id\>/ accepts GET, PUT and DELETE requests
The end-points for cutomer loyalty discounts:
http://localhoct:8000/api/discounts/loyalty/ accepts GET, POST requests
http://localhoct:8000/api/discounts/loyalty/\<id\>/ accepts GET, PUT and DELETE requests
The end-points to calculate discounts for an order:
http://localhoct:8000/api/discounts/calculate/ accepts POST requests
IMPORTANT: All request urls must end with a "/"
Get all customers:
curl -X GET http://localhost:8000/api/customers/
[{
"model":"customers.customer",
"pk":1,
"fields":{
"uid":"1",
"name":"Coca Cola",
"since":"2014-06-28",
"revenue":"492.12"
}
},...]
To get one specific customer, pass the customer id in the url:
curl -X GET http://localhost:8000/api/customers/1/
[{
"model":"customers.customer",
"pk":1,
"fields":{
"uid":"1",
"name":"Coca Cola",
"since":"2014-06-28",
"revenue":"492.12"
}
}]
To post a Product with a new category:
First create a new category, or the post for the product will be refused:
curl -H "Content-Type: application/json" -X POST -d @web/app/examples/resources/newcategory.json http://localhost:8000/api/products/categories/
[{
"model":"products.productcategory",
"pk":3,
"fields":{
"uid":"3",
"description":"Garden"
}
}]
Now we can post a new product:
curl -H "Content-Type: application/json" -X POST -d @web/app/examples/resources/newproduct.json http://localhost:8000/api/products/
[{
"model":"products.product",
"pk":6,
"fields":{
"uid":"C101",
"description":"Switch with motion detector",
"category":"3",
"price":"12.95"
}
}]
To calculate discounts for orders:
curl -H "Content-Type: application/json" -X POST -d @web/app/examples/resources/orders/order1.json http://localhost:8000/api/discounts/calculate/
{"total":"49.90",
"new_total":49.9,
"items":[
{
"unit-price":4.99,
"category":"2",
"product-id":"B102",
"free_products":{
"quantity_required":5,
"product_id":"B102",
"to_receive":2
},
"total":49.9,
"quantity":10
}
],
"customer-id":"1",
"loyalty_discount_details":null,
"id":"1",
"category_discounts":[
{
"category_id":"2",
"new_total":49.9,
"cheapest_product_discount":0.0,
"cheapest_product_discount_details":null,
"total":49.9,
"cheapest_product_price":4.99,
"quantity":10
}
]}
To update an existing entry in the database, we need to pass the entry's id in the url:
curl -H "Content-Type: application/json" -X PUT -d @web/app/examples/resources/editproduct.json http://localhost:8000/api/products/C101/
[{
"model":"products.product",
"pk":6,
"fields":{
"uid":"C101",
"description":"A tea pot!",
"category":"3",
"price":"0.01"
}
}]
To delete an entry from the database, we need to pass the entry's id in the url:
curl -H "Content-Type: application/json" -X DELETE -d @web/app/examples/resources/editproduct.json http://localhost:8000/api/products/C101/ -i
HTTP/1.1 204 No Content
Server: nginx/1.4.6 (Ubuntu)
Date: Sun, 23 Oct 2016 16:30:48 GMT
Content-Type: text/html; charset=utf-8
Connection: keep-alive
X-Frame-Options: SAMEORIGIN
Only one free product discount can be applied for a product. Attempting to add a 2 free product instance will return a 400 error.
Example:
- Buying 10 screw drivers
- Free product discount present: Buy 5, get 1 free
The outcome will be 2 free products.
There can be multiple category discounts for a category. The best option (based on quantity required) will be selected for the discount.
Example:
- Buying 5 products with category tools
- Category discount present: Buy 5, get 20% discount on cheapest product
- Category discount present: Buy 6, get 25% discount ont cheapest product
In this case, the option with Buy6, get %25% discount will be selected as we assume that the more items you buy, the higher the discount will be.
There can be multiple loyalty discounts. The best option (based on revenue required) will be selected for the discount.
Example:
- Customer has bought $2000
- Loyalty dicount: Required revenue: $1000, 10% discount
- Loyalty dicount: Required revenue: $2000, 20% discount
In this case, the option Required revenue: $2000, 20% discount will be selected as we assume that the more a customer spends, the higher the discount will be.
To facitilate operations, the admin site is available. To login to the admin interface, go to /admin/
- Username: admin
- Password: teapotapi
Teapot was designed and developed by Jaime Roeland in 2016. [email protected]