first stable version

Author: senvedat

.env.example

@@ -0,0 +1,23 @@
+# Server Config
+
+DEBUG=SACRET #True or False
+ALLOWED_HOSTS=SACRET
+SERVER_HOST=SACRET
+SERVER_PORT=SACRET
+
+# Database Config
+
+MASTER_DB_NAME=SACRET
+MASTER_DB_USER=SACRET
+MASTER_DB_PASSWORD=SACRET
+MASTER_DB_HOST=SACRET
+MASTER_DB_PORT=SACRET
+MASTER_DB_LOG_MODE=SACRET #True or False
+
+# Flask Settings
+
+SQLALCHEMY_TRACK_MODIFICATIONS = SACRET
+TESTING = SACRET
+DEBUG = SACRET
+FLASK_ENV = SACRET
+JWT_SECRET_KEY = SACRET

.gitignore

@@ -0,0 +1,29 @@
+# Binaries for programs and plugins
+.env
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+*.env
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+.idea/
+vendor/
+.vscode/
+tmp/
+
+#Envs
+.venv
+venv/
+
+#Some python additional
+__pycache__
+.pytest_cache

README.md

@@ -1,2 +1,103 @@
-# python-flask-postgresql-boilerplate
+
+# Project Desc
+
 A example Docker powered boilerplate of using postgresql with python flask
+
+
+## Tech Stack
+
+**Software Language:** Python
+
+**Framework:** Flask Framework
+
+**Database Type:** PostgreSQL
+
+**Extras:** Docker, JWT, Pytest
+
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+
+## API Reference
+
+#### Register
+
+```http
+  POST /api/v3/merchant/user/register
+```
+
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `email`   | `string` | **Required**.  |
+| `password`| `string` | **Required**.  |
+
+## ##
+## ##
+
+#### Login
+
+```http
+  POST /api/v3/merchant/user/login
+```
+
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `email`   | `string` | **Required**.  |
+| `password`| `string` | **Required**.  |
+
+
+Response:
+```http
+{
+    "status": "APPROVED",
+    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTY3MTAxNjIwMiwianRpIjoiNDkwZDFlMmUtOTUyNS00YTExLTg2ODAtZDRiYWNlMWNiYjBlIiwidHlwZSI6ImFjY2VzcyIsInN1YiI6IntcImNoZWNrX3Bhc3N3b3JkXCI6IG51bGwsIFwiZW1haWxcIjogXCJlbWFpbFwiLCBcImZpbmRfYnlfZW1haWxcIjogbnVsbCwgXCJmaW5kX2J5X2lkXCI6IG51bGwsIFwiaWRcIjogMiwgXCJwYXNzd29yZFwiOiBcInBhc3N3b3JkXCIsIFwicXVlcnlcIjogbnVsbCwgXCJxdWVyeV9jbGFzc1wiOiBudWxsLCBcInJlZ2lzdHJ5XCI6IG51bGwsIFwic2F2ZV90b19kYlwiOiBudWxsfSIsIm5iZiI6MTY3MTAxNjIwMiwiZXhwIjoxNjcxMDE2ODAyfQ.UwclY2gs4SfjROa8r3XW8NeDqdFLFM54JL4aJtGABb4"
+}
+```
+
+## ##
+## ##
+
+#### Transaction
+
+```http
+  POST /api/items/${id}
+```
+
+**NEED JWT BEARER TOKEN (Required, in header)**
+
+| Parameter | Type     | Description                       |
+| :-------- | :------- | :-------------------------------- |
+| `fromDate`      | `string` | **Required**. Ex: "2022-12-11" |
+| `toDate`      | `string` | **Required**. Ex: "2022-12-14" |
+| `merchant`      | `integer` | **Required**. Ex: 1 |
+| `acquirer`      | `integer` | **Required**. Ex: 2 |
+
+Response:
+```http
+{
+    "response": [
+        {
+            "count": 2,
+            "currency": "USD",
+            "total": 33
+        },
+        {
+            "count": 2,
+            "currency": "GBP",
+            "total": 85
+        }
+    ],
+    "status": "APPROVED"
+}
+```
+## ##
+
+
+## Example DB
+
+The sample database in the main file of the project in CSV format.
+
+`example.csv`
+

app/Dockerfile

@@ -0,0 +1,35 @@
+# Start from golang base image
+FROM python:3.10-alpine
+
+# Working directory
+WORKDIR /app
+
+# Copy requirments files
+COPY requirements.txt ./
+
+# Install requirments
+RUN pip3 install --no-cache-dir wheel
+RUN pip3 install --no-cache-dir -r requirements.txt
+
+# Copy everythings
+COPY . .
+
+# Expose port 8080 to the outside world
+EXPOSE 5000
+
+# Envs included
+ENV PYTHONUNBUFFERED 1
+
+# activate virtual environment
+ENV FLASK_APP='app'
+ENV FLASK_ENV='development'
+ENV FLASK_DEBUG=1
+ENV MASTER_DB_NAME=${MASTER_DB_NAME}
+ENV MASTER_DB_USER=${MASTER_DB_USER}
+ENV MASTER_DB_PASSWORD=${MASTER_DB_PASSWORD}
+ENV MASTER_DB_HOST=${MASTER_DB_HOST}
+ENV MASTER_DB_PORT=${MASTER_DB_PORT}
+ENV MASTER_DB_LOG_MODE=${MASTER_DB_LOG_MODE}
+
+#Command to run the executable
+CMD ["flask", "run","--host=0.0.0.0"]

app/__init__.py

@@ -0,0 +1,41 @@
+# from datetime import timedelta
+# from flask import Flask
+# from flask_jwt_extended import JWTManager
+# from flask_restful import Api
+
+# from app.resources.transaction import TransactionList
+# from app.resources.user import UserRegister, UserLogin
+# from app.config.config import postgresqlConfig
+
+# def create_app():
+#     app = Flask(__name__)
+
+#     app.config['SQLALCHEMY_DATABASE_URI'] = postgresqlConfig
+#     app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+#     app.config["JWT_SECRET_KEY"] = "JWT123SACRETKEY"
+#     app.config['JWT_TOKEN_LOCATION'] = ['headers']
+#     app.config["JWT_ACCESS_TOKEN_EXPIRES"] = timedelta(minutes=50)
+
+#     app.config.from_pyfile('config/config.py')
+
+#     jwt = JWTManager(app)
+#     api = Api(app, prefix="/api/v3")
+
+
+#     @app.before_first_request
+#     def create_tables():
+#         from app.config.db import db
+#         db.init_app(app)
+#         db.create_all()
+
+
+#     api.add_resource(UserRegister, '/register', methods=['POST'])
+#     api.add_resource(UserLogin, '/merchant/user/login', methods=['POST'])
+#     api.add_resource(TransactionList, '/transactions/report', methods=['POST'])
+    
+#     return app
+
+# app = create_app()
+
+# if __name__ == '__main__':
+#     app.run(host='0.0.0.0', port='5000',debug=True)

app/app.py

@@ -0,0 +1,36 @@
+from datetime import timedelta
+from flask import Flask
+from flask_jwt_extended import JWTManager
+from flask_restful import Api
+
+from app.resources.transaction import TransactionList
+from app.resources.user import UserRegister, UserLogin
+from app.config.config import postgresqlConfig
+
+app = Flask(__name__)
+
+app.config['SQLALCHEMY_DATABASE_URI'] = postgresqlConfig
+app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+app.config["JWT_SECRET_KEY"] = "JWT123SACRETKEY"
+app.config['JWT_TOKEN_LOCATION'] = ['headers']
+app.config["JWT_ACCESS_TOKEN_EXPIRES"] = timedelta(minutes=10)
+
+app.config.from_pyfile('config/config.py')
+
+jwt = JWTManager(app)
+api = Api(app, prefix="/api/v3")
+
+
+@app.before_first_request
+def create_tables():
+    from app.config.db import db
+    db.init_app(app)
+    db.create_all()
+
+
+api.add_resource(UserRegister, '/register', methods=['POST'])
+api.add_resource(UserLogin, '/merchant/user/login', methods=['POST'])
+api.add_resource(TransactionList, '/transactions/report', methods=['POST'])
+
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port='5000',debug=True)

app/config/config.py

@@ -0,0 +1,21 @@
+import os
+
+postgresql = {'host': os.environ["MASTER_DB_HOST"],
+              'user': os.environ["MASTER_DB_USER"],
+              'passwd': os.environ["MASTER_DB_PASSWORD"],
+              'db': os.environ["MASTER_DB_NAME"]}
+
+postgresqlConfig = "postgresql+psycopg2://{}:{}@{}/{}".format(
+    postgresql['user'], postgresql['passwd'], postgresql['host'], postgresql['db'])
+
+
+class Config(object):
+    SQLALCHEMY_TRACK_MODIFICATIONS = os.environ["SQLALCHEMY_TRACK_MODIFICATIONS"]
+    TESTING = os.environ["TESTING"]
+    DEBUG = os.environ["DEBUG"]
+    FLASK_ENV = os.environ["FLASK_ENV"]
+    JWT_SECRET_KEY = os.environ["JWT_SECRET_KEY"]
+    MASTER_DB_HOST = os.environ["MASTER_DB_HOST"]
+    MASTER_DB_USER = os.environ["MASTER_DB_USER"]
+    MASTER_DB_PASSWORD = os.environ["MASTER_DB_PASSWORD"]
+    MASTER_DB_NAME = os.environ["MASTER_DB_NAME"]

app/config/db.py

@@ -0,0 +1,4 @@
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()
+

app/models/__init__.py

@@ -0,0 +1,27 @@
+from app.config.db import db
+
+
+class TransactionModel(db.Model):
+    __tablename__ = 'transaction'
+
+    id = db.Column(db.Integer, primary_key=True)
+    merchant = db.Column(db.Integer)
+    acquirer = db.Column(db.Integer)
+    currency = db.Column(db.String())
+    amount = db.Column(db.Integer)
+    transactiondate = db.Column(db.DateTime(timezone=False))
+
+    def __init__(self, alert):
+        self.alert = alert
+
+    def json(self):
+        return {'data': self.alert}
+
+    def save_to_db(self):  
+        db.session.add(self)
+        db.session.commit()  
+
+    def delete_from_db(self):
+        db.session.delete(self)
+        db.session.commit()
+

app/models/transaction.py

@@ -0,0 +1,30 @@
+from app.config.db import db
+from werkzeug.security import hmac
+
+
+class UserModel(db.Model):
+    __tablename__ = 'users'
+
+    id = db.Column(db.Integer, primary_key=True)
+    email = db.Column(db.String(100))
+    password = db.Column(db.String(100))
+
+    def __init__(self, email, password):
+        self.email = email
+        self.password = password
+
+    def save_to_db(self):
+        db.session.add(self)
+        db.session.commit()
+
+    def check_password(self, password):
+        return hmac.compare_digest(self.password, password)
+
+    @classmethod
+    def find_by_email(cls, email):
+        return cls.query.filter_by(email=email).first()
+
+    @classmethod
+    def find_by_id(cls, _id):
+        return cls.query.filter_by(id=_id).first()
+

app/models/user.py

@@ -0,0 +1,13 @@
+Flask==2.2.2
+Flask-RESTful==0.3.9
+Flask-SQLAlchemy==3.0.2
+Jinja2==3.1.2
+Flask-JWT-Extended==4.2.1
+pytest==7.2.0
+python-dateutil==2.8.1
+python-dotenv==0.21.0
+pytz==2021.1
+SQLAlchemy==1.4.45
+Werkzeug==2.2.2
+psycopg2-binary
+rich