Customer Accounts

Repository for customer accounts handling.

Development Environment Setup:

Follow these instructions: Software Development Guide - Spring 2022

Contents

The project contains the following:

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

service/                   - service python package
├── __init__.py            - package initializer
├── models.py              - module with business models
├── routes.py              - module with service routes
└── common                 - common code package
    ├── error_handlers.py  - HTTP error handling code
    ├── log_handlers.py    - logging setup code
    └── status.py          - HTTP status constants

tests/              - test cases package
├── __init__.py     - package initializer
├── test_models.py  - test suite for business models
└── test_routes.py  - test suite for service routes

Information about this repo

These are the RESTful routes for customers

Endpoint          Methods  Rule
----------------  -------  -----------------------------------------------------
index             GET      /

list_customers     GET      /customers
create_customers   POST     /customers
get_customer      GET      /customers/<customer_id>
update_customer   PUT      /customers/<customer_id>
delete_customer   DELETE   /customers/<customer_id>

The test cases have 97% test coverage and can be run with nosetests

License

Copyright (c) John Rofrano. All rights reserved.

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.