Payments Service

This is a skeleton you can use to start your projects

Overview

This project template contains starter code for your class project. The /service folder contains your models.py file for your model and a routes.py file for your service. The /tests folder has test case starter code for testing the model and the service separately. All you need to do is add your functionality. You can use the lab-flask-tdd for code examples to copy from

Dev Environment Setup

Using Visual Studio Code

### Requirements 1. Visual Studio Code 2. Docker 3. Install the Dev Containers extension on VS Code ### Install instructions 1. Git clone this repo to your machine 2. Start VS Code, run the `Dev Containers: Open Folder in Container...` command from the Command Palette (`F1`) 3. Try `pytest` in the terminal to run tests make sure the environment has been installed correctly.

Common issues

1. Database cannot connect / authentication is wrong. - Check that the `DATABASE_URI` being used in the repository matches up and the postgres container is running in docker. You may need to recreate the database. 2. Can't start up the dev environment on VS Code. - You may need to delete instances of the containers which may have conflicting names with your existing configuration. Alternatively you can also change the config file.

Local Deployment

To launch deployment, we need to have a docker image in the local registry. Currently, the deployment build uses payments:latest.

# build image for local registry if not existing
docker build -t payments:latest.
docker tag payments:3.0 cluster-registry:32000/payments:latest
docker push cluster-registry:32000/payments:latest

make cluster 
kubectl apply -f k8s/  # launch app

The database may take up to a minute to be ready to listen to requests, which may cause some restarts in the app pod while initializing.

Commands to tear down deployment:

kubectl delete -f k8s/
make cluster-rm

App Endpoints

/index              - Root URL
/payments   
                    - GET : List all payment methods for a user
/payments   
                    - POST: Create a payment method
/payments/:id
                    - GET: Provide detailed information about an existing payment method
                    - PUT: Update a given payment method
                    - DELETE: Delete a payment method

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
pyproject.toml      - Poetry list of Python libraries required by your code

service/                   - service python package
├── __init__.py            - package initializer
├── config.py              - configuration parameters
├── models.py              - module with business models
├── routes.py              - module with service routes
└── common                 - common code package
    ├── cli_commands.py    - Flask command to recreate all tables
    ├── 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_cli_commands.py   - test suite for the CLI
├── test_models.py         - test suite for business models
└── test_routes.py         - test suite for service routes

License

Licensed under the Apache License. See LICENSE

This repository is part of the New York University (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-SP24-003 / payments

readme