promotions: A Python repository from ggrace7

Overview

The promotions resource is a representation of a special promotion or sale that is running against a product or perhaps the entire store. Some examples are "buy 1 get 1 free", "20% off", etc. Discount promotions usually apply for a given duration (e.g., sale for 1 week only).

The project contains the following:

service/            - service python package
├── __init__.py     - package initializer
├── models.py       - module with promotion models
└── service.py      - module with service routes

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

.coveragerc         - settings file for code coverage options
.gitignore          - this will ignore vagrant and other metadata files
dot-env-example     - copy to .env to use environment variables
requirements.txt    - list if Python libraries required by your code
config.py           - configuration parameters
setup.cfg           - nosetests configuration file
LICENSE             - Apache 2.0
Vagrantfile         - Vagrant file that installs Python 3 and PostgreSQL

Setup

Prerequisite Installation using Vagrant

The easiest way to use this is with Vagrant and VirtualBox. If you don't have this software the first step is download and install it. If you have an 2020 Apple Mac with the M1 chip, you should download Docker Desktop instead of VirtualBox. Here is what you need: Download: Vagrant Intel Download: VirtualBox Apple M1 Download: Apple M1 Tech Preview Install each of those. Then all you have to do is clone this repo and invoke vagrant:

Using Vagrant and VirtualBox

Git clone https://github.com/DevOpsS21-Promotions/promotions.git
cd promotions
vagrant up

You can now ssh into the virtual machine and run the service and the test suite:

vagrant ssh
cd /vagrant

Starting Service

To run the service use flask run (Press Ctrl+C to exit):

cp dot-env-example .env
flask run -h 0.0.0.0

FLASK_APP=service:app flask run -h 0.0.0.0

You must pass the parameters -h 0.0.0.0 to have it listed on all network adapters to that the post can be forwarded by vagrant to your host computer so that you can open the web page in a local browser at: http://localhost:5000

Running the Tests

Run the tests using nosetests

nosetests

Nose is configured via the included setup.cfg file to automatically include the flags --with-spec --spec-color so that red-green-refactor is meaningful. If you are in a command shell that supports colors, passing tests will be green while failing tests will be red. Nose is also configured to automatically run the coverage tool and you should see a percentage of coverage report at the end of your tests. If you want to see what lines of code were not tested use:

coverage report -m

This is particularly useful because it reports the line numbers for the code that is not covered so that you can write more test cases to get higher code coverage.

Promotion Model

“name” - name of promotion
“description” - description of promotion
“promo_code” - promotion code for promotion
“start_date” - start date of promotion
“end_date” - end date of promotion
“is_active” - Is the promotion active

How To Use

RESTful service for Promotions

GET /promotions - Returns a list all of the Promotions
GET /promotions/{id} - Returns the Promotion with a given id number
POST /promotions - creates a new Promotion record in the database
PUT /promotions/{id} - updates a Promotion record in the database
DELETE /promotions/{id} - deletes a Promotion record in the database

_{This repository is part of the NYU class CSCI-GA.2810-001: DevOps and Agile Methodologies taught by John Rofrano, Adjunct Instructor, NYU Curant Institute, Graduate Division, Computer Science.}

ggrace7/promotions