NYU DevOps Project - Orders Service

Orders Service - Represents the orders placed by Customers at an eCommerce Website

Overview

This project contains the code for Orders Service. The service consists of Orders Resource and OrderItem Resource (subordinate). The /service folder contains the models.py file for Order and OrderItem models and a routes.py file for the service. The /tests folder contains the test cases for testing the model and the service separately.

Running the service locally

To run the Orders service on a local machine, first clone the repository and then run the following commands:

cd orders
code .
Reopen the folder in Dev Container
Run honcho start command on the terminal
The service is available at localhost: http://localhost:8080

To run the all the test cases locally, please run the command nosetests.

The project contains the following:

.gitignore          - this will ignore vagrant and other metadata files
.flaskenv           - Environment variables to configure Flask
.gitattributes      - File to fix Windows CRLF issues
.devcontainer/      - Folder with support for VSCode Remote Containers
dot-env-example     - copy to .env to use environment variables
requirements.txt    - list of Python libraries required by your code
setup.cfg           - configuration parameters

service/                   - service python package
├── __init__.py            - package initializer
├── config.py              - configs for the app
├── models.py              - module with business models
├── routes.py              - module with service routes
└── common                 - common code package
    ├── cli_commands       - custom commands to use with flask
    ├── error_handlers.py  - HTTP error handling code
    ├── log_handlers.py    - logging setup code
    └── status.py          - HTTP status constants
└── static                 - code for UI of the homepage
    ├── css/               - styles for index.html
    ├── images/            - images for index.html
    ├── js/                - javascripts for index.html
    └── index.html         - the root for UI webpage

tests/                - test cases package
├── __init__.py       - package initializer
├── factories.py      - factory to generate instances of model
├── test_cli_commands - tests custom flask cli commands
├── test_models.py    - test suite for business models
└── test_routes.py    - test suite for service routes

features/                 - bdd test cases package
├── orders.feature        - orders test scenarios
├── order_items.feature   - order_items test scenarios
├── environment.py        - environment for bdd tests
└── steps                 - code for describing bdd steps
    ├── steps.py          - steps for orders.feature and order_items.feature
    
deploy/               - yaml files for kubernetes deployment
├── deployment.yaml   - Deployment for orders api
├── postgresql.yaml   - StatefulSet, Service, Secret for postgres db 
├── service.yaml      - Service for orders api

Order Service APIs

Index

GET /

Success Response : 200 OK

{
  "name": "Order REST API Service",
  "paths": "http://localhost:8080/orders",
  "version": "1.0"
}

Order Operations

Description	Endpoint
Create an Order	POST `/orders`
Read/Get an Order by ID	GET `/orders/<order_id>`
Update an existing Order	PUT `/orders/<order_id>`
Delete an Order	DELETE `/orders/<order_id>`
Search Orders	GET `/orders?<query_field>=<query_value>`

Order Item Operations

Description	Endpoint
Create an Order Item	POST `/orders/<order_id>/items`
Read/Get an Order Item	GET `/orders/<order_id>/items/<item_id>`
Update an Order Item	PUT `/orders/<order_id>/items/<item_id>`
Delete an Order Item	DELETE `/orders/<order_id>/items/<item_id>`
List Items of an Order	GET `/orders/<order_id>/items`

Order Service APIs - Usage

Create an Order

Endpoint : /orders

Method : POST

Content-Type: application/json

Authentication required : None

The items can also be created with this API by sending an array of items in the JSON request.

Example:

Request Body (JSON)

{
  "customer_id": 6,
  "items": []
}

Success Response : 201 CREATED

{
  "created_on": "2023-03-07",
  "customer_id": 6,
  "id": 1,
  "items": [],
  "status": "CONFIRMED",
  "updated_on": "2023-03-07"
}

Read/Get an Order

Endpoint : /orders/<order_id>

Method : GET

Authentication required : None

Example:

GET /orders/1

Success Response : 200 OK

{
  "created_on": "2023-03-07",
  "customer_id": 6,
  "id": 1,
  "items": [],
  "status": "CONFIRMED",
  "updated_on": "2023-03-07"
}

Failure Response : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

Cancel an Order

Endpoint : /orders/<order_id>/cancel

Method : PUT

Authentication required : None

Example:

PUT /orders/1

Success Response : 200 OK

{
  "created_on": "2023-03-07",
  "customer_id": 6,
  "id": 1,
  "items": [],
  "status": "CANCELLED",
  "updated_on": "2023-03-07"
}

Failure Response : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

Failure Response : 409 CONFLICT

{
  "error": "Conflict",
  "message": "409 Conflict: Order with id '1' cannot be cancelled.",
  "status": 409
}

Update an Order

Endpoint : /orders/<order_id>

Method : PUT

Content-Type: application/json

Authentication required : None

This API will only update order attributes, and will not update any of the order items.

Example:

Request Body (JSON)

{
    "customer_id": 4,
    "status": "DELIVERED"
}

Success Response : 200 OK

{
  "created_on": "2023-03-07",
  "customer_id": 4,
  "id": 1,
  "items": [],
  "status": "DELIVERED",
  "updated_on": "2023-03-07"
}

Failure Response : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

Delete an Order

Endpoint : /orders/<order_id>

Method : DELETE

Authentication required : None

This API will delete an order and all of its items.

Example:

DELETE /orders/1

Success Response : 204 NO CONTENT

Search All Orders

Endpoint : /orders?<query_field>=<query_value>

Method : GET

Authentication required : None

Example:

GET /orders?customer_id=6

Success Response : 200 OK

[
  {
    "created_on": "2023-03-06",
    "customer_id": 6,
    "id": 1,
    "items": [],
    "status": "CONFIRMED",
    "updated_on": "2023-03-06"
  }
]

Create an Order Item

Endpoint : /orders/<order_id>/items

Method : POST

Content-Type: application/json

Authentication required : None

Example:

Request Body (JSON)

{
  "product_id": 65,
  "price": 20,
  "quantity": 2
}

Success Response : 201 CREATED

{
  "created_on": "2023-03-07",
  "id": 1,
  "order_id": 1,
  "price": 20.0,
  "product_id": 65,
  "quantity": 2,
  "updated_on": "2023-03-07"
}

Failure Response (When invalid Order ID is provided in the URL) : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

Read/Get an Order Item

Endpoint : /orders/<order_id>/items/<item_id>

Method : GET

Authentication required : None

Example:

GET /orders/1/items/1

Success Response : 200 OK

{
  "created_on": "2023-03-07",
  "id": 1,
  "order_id": 1,
  "price": 20.0,
  "product_id": 65,
  "quantity": 2,
  "updated_on": "2023-03-07"
}

Failure Response : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

{
  "error": "Not Found",
  "message": "404 Not Found: Item with id '1' was not found.",
  "status": 404
}

Update an Order Item

Endpoint : /orders/<order_id>/items/<item_id>

Method : PUT

Content-Type: application/json

Authentication required : None

Example:

Request Body (JSON)

{
  "product_id": 3,
  "price": 89,
  "quantity": 1
}

Success Response : 200 OK

{
  "created_on": "2023-03-06",
  "id": 1,
  "order_id": 1,
  "price": 89.0,
  "product_id": 3,
  "quantity": 1,
  "updated_on": "2023-03-07"
}

Failure Response : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

{
  "error": "Not Found",
  "message": "404 Not Found: Item with id '1' was not found.",
  "status": 404
}

Delete an Order Item

Endpoint : /orders/<order_id>/items/<item_id>

Method : DELETE

Authentication required : None

Example:

DELETE /orders/1/items/1

Success Response : 204 NO CONTENT

Failure Response : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

List All Items of an Order

Endpoint : /orders/<order_id>/items

Method : GET

Authentication required : None

Example:

GET /orders/1/items

Example:

Success Response : 200 OK

[
  {
    "created_on": "2023-03-06",
    "id": 1,
    "order_id": 1,
    "price": 89.0,
    "product_id": 3,
    "quantity": 1,
    "updated_on": "2023-03-07"
  }
]

Failure Response : 404 NOT FOUND

{
  "error": "Not Found",
  "message": "404 Not Found: Order with id '1' was not found.",
  "status": 404
}

Running BDD Tests Locally

Follow these steps to run the BDD tests locally:

Once the container is up and running, execute honcho start.
Open another terminal window within the container and execute behave.
The BDD tests should start running and displaying the results.

Accessing the Service on the Cloud

The service is deployed on the Kubernetes clusters in the Cloud. You can access it at:

Development cluster url: http://159.122.186.49:31001
Production cluster url: http://159.122.186.49:31002

Flask-RESTX

You can find the API documentation at [url]/apidocs, for example: http://localhost:8080/apidocs

License

Licensed under the Apache License. See LICENSE

This repository is part of the NYU masters class: CSCI-GA.2820-001 DevOps and Agile Methodologies created and taught by John Rofrano, Adjunct Instructor, NYU Courant Institute, Graduate Division, Computer Science, and NYU Stern School of Business.

CSCI-GA-2820-SP23-003/orders

NYU DevOps Project - Orders Service

Overview

Running the service locally

Contents

Order Service APIs

Index

Order Operations

Order Item Operations

Order Service APIs - Usage

Create an Order

Read/Get an Order

Cancel an Order

Update an Order

Delete an Order

Search All Orders

Create an Order Item

Read/Get an Order Item

Update an Order Item

Delete an Order Item

List All Items of an Order

Running BDD Tests Locally

Accessing the Service on the Cloud

Flask-RESTX

License