Creates tests for the store manager api and its endpoints

.gitignore

@@ -57,7 +57,7 @@ local_settings.py
 db.sqlite3
 
 # Flask stuff:
-instance/
+#instance/
 .webassets-cache
 
 # Scrapy stuff:
@@ -102,3 +102,6 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# VS code settings
+.vscode/

.travis.yml

@@ -0,0 +1,31 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=18007e474cdfcf70da58a682805aff9f88216339b0dce34454dc0bfcc988ea91
+    - APP_SETTINGS="development"
+    - SECRET_KEY="mvangiffj38kncliu3yt7gvLWDNTDISFJWrk'\flQHJsdnlQI2ROH"
+
+language: python
+
+# python version
+python:
+  - "3.6"
+
+# command to install dependencies
+install:
+  - pip install -r requirements.txt
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+# command to run tests
+script:
+  - coverage run --source=app.api.v1 -m pytest app/tests/v1 -v -W error::UserWarning && coverage report
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+# Post coverage results to coverage.io
+after_success:
+  - coveralls

Procfile

@@ -0,0 +1 @@
+web: gunicorn run:app

README.md

@@ -1,2 +1,86 @@
 # store-manager-api
+
+#### Continous Integration badges
+[![Build Status](https://travis-ci.com/calebrotich10/store-manager-api.svg?branch=develop)](https://travis-ci.com/calebrotich10/store-manager-api) [![Coverage Status](https://coveralls.io/repos/github/calebrotich10/store-manager-api/badge.svg?branch=develop)](https://coveralls.io/github/calebrotich10/store-manager-api?branch=develop) [![Maintainability](https://api.codeclimate.com/v1/badges/e87820f417b8d15c3a64/maintainability)](https://codeclimate.com/github/calebrotich10/store-manager-api/maintainability)
+
+
 Store Manager is a web application that helps store owners manage sales and product inventory records. This application is meant for use in a single store. This repository contains the API endpoints for the application.
+
+#### Endpoints
+<table>
+  <tr>
+    <th>Http Method</th>
+    <th>Endpoint</th>
+    <th>Functionality</th>
+  </tr>
+  <tr>
+    <td>POST</td>
+    <td>api/v1/auth/signup</td>
+    <td>Creates a new user account</td>
+  </tr>
+  <tr>
+    <td>POST</td>
+    <td>api/v1/products</td>
+    <td>Used by the admin to add a new product</td>
+  </tr>
+  <tr>
+    <td>POST</td>
+    <td>api/v1/saleorder</td>
+    <td>Used by the sale attendant to add a new sale order</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>api/v1/auth/signin</td>
+    <td>Authenticates and creates a token for the users</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>api/v1/products/&ltproduct_id&gt</td>
+    <td>Enables a user to fetch a specific product</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>api/v1/saleorder/&ltsale_order_id&gt</td>
+    <td>Enables a user to fetch a specific sale order</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>api/v1/products</td>
+    <td>Enables a user to fetch all products</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>api/v1/saleorder</td>
+    <td>Enables a user to fetch all sale orders</td>
+  </tr>
+</table>
+
+#### Installing the application
+1. Open a command terminal in your preferred folder
+2. Run command `git clone https://github.com/calebrotich10/store-manager-api.git` to have a copy locally
+3. `cd store-manager-api`
+4. Create a virtual environment for the application `virtualenv venv`
+5. Install dependencies from the `requirements.txt` file `pip3 install -r requirements.txt`
+6. Export environment variables to your environment ```export JWT_SECRET_KEY=your-secret-key```, ```export FLASK_APP="run.py"```
+6. Run the application using flask command `flask run` or using python3 `python3 run.py`
+
+#### Running tests
+Inside the virtual environment created above, run command: `coverage run --source=app.api.v1 -m pytest app/tests/v1 -v -W error::UserWarning && coverage report`
+
+#### Technologies used
+1. `JWT` for authentication
+2. `pytest` for running tests
+3. Python based framework `flask`
+4. Flask packages
+
+#### Deployment
+[Heroku](https://store-manager-api.herokuapp.com/api/v1/products)
+
+#### Documentation
+https://documenter.getpostman.com/view/5265531/RWguxwzy
+
+#### Author
+[Caleb Rotich](https://github.com/calebrotich10)
+
+#### Credits
+This application was build as part of the Andela NBO 33 challenge

app/__init__.py

@@ -0,0 +1,23 @@
+import os
+
+from flask import Flask
+from flask_jwt_extended import JWTManager
+
+from instance.config import config
+
+jwt = JWTManager()
+
+def create_app(config_name):
+    app = Flask(__name__)
+    app.config.from_object(config[config_name])
+    app.config['JWT_SECRET_KEY'] = os.getenv('JWT_SECRET_KEY', default='SdaHv342nx!jknr837bjwd?c,lsajjjhw673hdsbgeh')
+
+    jwt.init_app(app)
+
+    from .api.v1 import endpoint_v1_blueprint as v1_blueprint
+    app.register_blueprint(v1_blueprint, url_prefix='/api/v1')
+
+    from .api.v1 import auth_v1_blueprint as v1_blueprint
+    app.register_blueprint(v1_blueprint, url_prefix='/api/v1/auth')
+
+    return app

app/api/v1/__init__.py

@@ -0,0 +1,9 @@
+from flask import Blueprint
+
+
+endpoint_v1_blueprint = Blueprint('endpoint_v1_blueprint', __name__)
+auth_v1_blueprint = Blueprint('auth_v1_blueprint', __name__)
+
+
+
+from . import views

app/api/v1/models/products.py

@@ -0,0 +1,24 @@
+"""This module contains the data store
+
+and data logic of the store's products
+"""
+
+PRODUCTS = []
+
+class Products():
+    def __init__(self, product_name, product_price, category):
+        self.id = len(PRODUCTS) + 1
+        self.product_name = product_name
+        self.product_price = product_price
+        self.category = category
+
+    def save(self):
+        new_product = {
+            "product_id": self.id,
+            "product_name": self.product_name,
+            "product_price": self.product_price,
+            "category": self.category
+            }
+
+        PRODUCTS.append(new_product)
+        return new_product

app/api/v1/models/sale_orders.py

@@ -0,0 +1,26 @@
+"""This module contains the data store
+
+and data logic of the store attendant's sale orders
+"""
+from flask import jsonify
+
+SALE_ORDERS = []
+
+class SaleOrder():
+    def __init__(self, product_name, product_price, quantity):
+        self.id = len(SALE_ORDERS) + 1
+        self.product_name = product_name
+        self.product_price = product_price
+        self.quantity = quantity
+
+    def save(self):
+        new_sale_order = {
+            "sale_order_id": self.id,
+            "product_name": self.product_name,
+            "product_price": self.product_price,
+            "quantity": self.quantity,
+            "amount": (self.product_price * self.quantity)
+            }
+
+        SALE_ORDERS.append(new_sale_order)
+        return new_sale_order

app/api/v1/models/users.py

@@ -0,0 +1,27 @@
+from flask import make_response, jsonify
+USERS = []
+
+
+class User_Model():
+    def __init__(self, email, password, role):
+        self.id = len(USERS) + 1
+        self.email = email
+        self.password = password
+        self.role = role
+
+    def save(self):
+        new_user = {
+            "id": self.id,
+            "email": self.email,
+            "password": self.password,
+            "role": self.role
+            }
+
+        new_added_user = {
+            "id": self.id,
+            "email": self.email,
+            "role": self.role
+            }
+
+        USERS.append(new_user)
+        return new_added_user

app/api/v1/resources/admin_endpoints.py

@@ -0,0 +1,70 @@
+"""This module contains endpoints
+
+that are specific to the admin
+"""
+import os
+import jwt
+from functools import wraps
+
+from flask import Flask, jsonify, request, abort, make_response
+from flask_restful import Resource
+from flask_jwt_extended import get_jwt_identity, jwt_required
+
+from . import helper_functions
+from app.api.v1.models import products, sale_orders, users
+from . import verify
+
+
+class ProductsManagement(Resource):
+    """Class contains admin specific endpoints"""
+
+
+    def post(self):
+        """POST /products endpoint"""
+
+        # Token verification and admin user determination
+        logged_user = verify.verify_tokens()
+        helper_functions.abort_if_user_is_not_admin(logged_user)
+
+        data = request.get_json()
+        helper_functions.no_json_in_request(data)
+        try:
+            product_name = data['product_name']
+            product_price = data['product_price']
+            category = data['category']
+        except KeyError:
+            # If product is missing required parameter
+            helper_functions.missing_a_required_parameter()
+
+        verify.verify_post_product_fields(product_price, product_name, category)
+
+        response = helper_functions.add_product_to_store(product_name, product_price, category)
+
+        return make_response(jsonify({
+            "message": "Product added successfully",
+            "product": response
+        }), 201)
+
+
+class SaleAttendantsManagement(Resource):
+    """Class contains the tests managing
+
+    sale orders
+    """
+
+    def get(self):
+        """GET /saleorder endpoint"""
+
+        verify.verify_tokens()
+
+        if not sale_orders.SALE_ORDERS:
+            # If no products exist in the store yet
+            abort(make_response(
+                jsonify(message="There are no sale orders made yet"), 404))
+        # if at least one product exists
+        response = jsonify({
+            'message': "Successfully fetched all the sale orders",
+            'sale_orders': sale_orders.SALE_ORDERS
+            })
+        response.status_code = 200
+        return response

app/api/v1/resources/auth.py

@@ -0,0 +1,60 @@
+import os
+import datetime
+import jwt
+from werkzeug.security import generate_password_hash, check_password_hash
+from functools import wraps
+
+from flask import Flask, jsonify, request, make_response
+from flask_restful import Resource
+from flask_jwt_extended import (
+    jwt_required, create_access_token,
+    get_jwt_identity
+)
+
+from instance import config
+from app.api.v1.utils.validator import Validator
+from app.api.v1.models import users
+
+class SignUp(Resource):
+    def post(self):
+        data = request.get_json()
+        if not data:
+            return make_response(jsonify({
+                                    "message": "Missing required credentials"
+                                    }), 400)
+        email = data["email"].strip()
+        password = generate_password_hash(data["password"].strip(), method='sha256')
+        role = data["role"].strip()
+        Validator.validate_credentials(self, data)
+        user = users.User_Model(email, password, role)
+        res = user.save()
+        return make_response(jsonify({
+            "message": "Account created successfully",
+            "user": res
+        }), 202)
+
+
+class Login(Resource):
+    def post(self):
+        data = request.get_json()
+        if not data:
+            return make_response(jsonify({
+                "message": "Kindly enter your credentials"
+            }
+            ), 400)
+        email = data["email"].strip()
+        password = data["password"].strip()
+
+        for user in users.USERS:
+            if email == user["email"] and check_password_hash(user["password"], password):
+                token = jwt.encode({
+                    "email": email,
+                    "exp": datetime.datetime.utcnow() + datetime.timedelta(minutes=30)                                  
+                }, os.getenv('JWT_SECRET_KEY', default='SdaHv342nx!jknr837bjwd?c,lsajjjhw673hdsbgeh'))
+                return make_response(jsonify({
+                             "message": "Login successful",
+						     "token": token.decode("UTF-8")}), 200)
+        return make_response(jsonify({
+            "message": "Wrong credentials provided"
+        }
+        ), 403)