Release v1.4.22 beta

Revision 1.4.22_beta

Author: owlCoder

README.md

@@ -112,7 +112,7 @@ Before you can run the Flask API, you need to activate your virtual environment.
 To start the Flask API, run the following command within the activated virtual environment:
 
 ```bash
-python index.py
+flask --app index.py run --debug
 ```
 
 This will start the development server, and your API will be accessible at `http://localhost:5000/`.

api/Dockerfile

@@ -1,20 +1,21 @@
-# Use a base image with Python
-FROM python:3.9
+# Use a slim Python image as the base
+FROM python:3.9-slim
 
 # Set the working directory inside the container
 WORKDIR /app
 
-# Copy the requirements.txt file and install dependencies
+# Copy just the requirements file and install dependencies
 COPY requirements.txt .
 
 # Install Python dependencies
 RUN pip install --no-cache-dir -r requirements.txt
 
-# Copy all the files from the current directory to the container
+# Copy the rest of the application code
 COPY . .
 
-# Expose the port your app runs on
+# Expose the port Gunicorn will listen on
 EXPOSE 5000
 
-# Command to run the Flask application
-CMD ["python", "index.py"]
+# Command to run the Flask application using Gunicorn with eventlet worker
+# Add gunicron & eventlet in requiremens.txt to run in production
+CMD ["gunicorn", "-w", "4", "-k", "eventlet", "-b", "0.0.0.0:5000", "index:app"]

api/app_factory.py

@@ -1,9 +1,8 @@
 from flask import Flask
 from flask_cors import CORS
-from flasgger import Swagger
+
 from services.transcation_proccessing import start_schedule_background
 
-from config.socket import socketio
 from config.database import db
 from config.config import ALLOWED_CLIENT_ORIGIN
 
@@ -18,26 +17,16 @@
 def create_app():
     app = Flask(__name__)
     app.config.from_pyfile('config/config.py')
+    app.config['SECRET_KEY'] = 'transaction_systems_wm_1594'
 
     # Initialize CORS
     CORS(app, origins=[ALLOWED_CLIENT_ORIGIN], methods=["POST", "GET", "PUT"])
 
     # Initialize database engine
     db.init_app(app)
-    
-    # Initialize SocketIO for real-time updates
-    socketio.init_app(app, cors_allowed_origins=ALLOWED_CLIENT_ORIGIN)
-    
-    # Swagger configuration
-    app.config['SWAGGER'] = {
-        'title': 'Transaction Systems API',
-        'version': '1.32.1',
-        'uiversion': 3,
-        'swagger_ui': True,
-        'specs_route': '/api/',
-        'swagger_ui_css': '/static/swagger-ui.css'
-    }
-    Swagger(app)
+
+    from config.socket import socket_io
+    socket_io.init_app(app, cors_allowed_origins=ALLOWED_CLIENT_ORIGIN)
 
     # Register blueprints
     app.register_blueprint(auth_blueprint)
@@ -47,7 +36,7 @@ def create_app():
     app.register_blueprint(current_account_blueprint)
     app.register_blueprint(currencies_blueprint)
     app.register_blueprint(transaction_blueprint)
-    
+
     # Start Transaction System service in background
     start_schedule_background(app)
 

api/config/exlude_docs_str.py

@@ -1,15 +1,11 @@
-from flask_socketio import Namespace
 from flask_socketio import SocketIO
 
-# Define new realtime socket
-socketio = SocketIO()
+socket_io = SocketIO()
 
-# Define a custom namespace
-class RealTimeNamespace(Namespace):
-    def on_connect(self):
-        print('Client connected to realtime updates service')
+@socket_io.on("connect")
+def connection():
+    print("Connected!")
 
-    def on_disconnect(self):
-        print('Client disconnected from realtime updates service')
-
-socketio.on_namespace(RealTimeNamespace('/api/realtime'))
+@socket_io.on("disconnect")
+def connection():
+    print("Disconnected!")

api/config/socket.py

@@ -5,26 +5,6 @@
 
 # Method to create a new credit card
 def create_credit_card(data):
-    """
-    Create a credit card record submitted by a user via form.
-
-    Args:
-        data (dict): A dictionary containing card information: 'card_number', 'cardholder_name', 'expiry_date', 'cvv', 'uid'.
-
-    Returns:
-        bool: True if the credit card is successfully created, False otherwise.
-
-    Example:
-        data = {
-            'card_number': '1234567890123456',
-            'cardholder_name': 'John Doe',
-            'expiry_date': '12/25',
-            'cvv': '123',
-            'uid': 1
-        }
-        result = create_credit_card(data)
-        print(result)  # True or False
-    """
     card_number = data.get('card_number')
     cardholder_name = data.get('cardholder_name')
     expiry_date = data.get('expiry_date')
@@ -51,19 +31,6 @@ def create_credit_card(data):
 
 # Method to check is credit card exist
 def check_credit_card_by_uid(uid):
-    """
-    Check if a user has a credit card by user ID.
-
-    Args:
-        uid (int): The user ID to check.
-
-    Returns:
-        bool: True if the user has a credit card, False otherwise.
-
-    Example:
-        has_card = check_credit_card_by_uid(1)
-        print(has_card)  # True or False
-    """
     try:
         card = db.session.query(CreditCard).filter(CreditCard.uid == uid).first()
         return card is not None  # Return True if user has credit card, False otherwise
@@ -72,19 +39,6 @@ def check_credit_card_by_uid(uid):
 
 # Method to get all credit cards owned by user
 def get_all_credit_cards_by_uid(uid):
-    """
-    Retrieve all credit cards associated with a user ID.
-
-    Args:
-        uid (int): The user ID.
-
-    Returns:
-        list: A list containing serialized credit card data for the given user ID. Returns None if an error occurs.
-
-    Example:
-        credit_cards = get_all_credit_cards_by_uid(1)
-        print(credit_cards)  # List of credit card data or None
-    """
     try:
         credit_cards = db.session.query(CreditCard).filter(CreditCard.uid == uid).all()
         return [card.serialize() for card in credit_cards]
@@ -93,20 +47,6 @@ def get_all_credit_cards_by_uid(uid):
 
 # Method to verify user's credit card
 def update_verified_field(card_number, verified_status):
-    """
-    Update the 'verified' field of a credit card by card number.
-
-    Args:
-        card_number (str): The card number of the credit card.
-        verified_status (bool): The status to set for the 'verified' field.
-
-    Returns:
-        bool: True if the 'verified' field is successfully updated, False otherwise.
-
-    Example:
-        result = update_verified_field('1234567890123456', True)
-        print(result)  # True or False
-    """
     try:
         credit_card = db.session.query(CreditCard).filter(CreditCard.card_number == card_number).first()
         if credit_card:

api/controllers/credit_card.py

@@ -1,27 +1,9 @@
 from decimal import Decimal
-from services.account_number_generator import generate_account_number
 from models.current_account import CurrentAccount
 from config.database import db
 
 # Method to create a new current account
 def create_current_account(account_number, balance, currency, card_number, uid):
-    """
-    Creates a new current account.
-
-    Args:
-        account_number (str): The account number of the current account.
-        balance (float): The initial balance in the account.
-        currency (str): The currency type of the account.
-        card_number (str): The associated credit card number.
-        uid (int): The user ID associated with the account.
-
-    Returns:
-        True or False: Returns True if the account is created successfully,
-                     otherwise returns False.
-
-    Example:
-        is_created = create_current_account("1234567890", 1000.00, "USD", "1234567890123456", 1)
-    """
     try:
         new_account = CurrentAccount(
             account_number=account_number,
@@ -38,48 +20,22 @@ def create_current_account(account_number, balance, currency, card_number, uid):
         return False
 
 # Method to check if an account exists based on UID and currency
-def check_account_exists(uid, card_number, currency):
-    """
-    Checks if an account exists based on user ID, card number and currency.
-
-    Args:
-        uid (int): The user ID associated with the account.
-        card_number (str): The user card number associated with the account.
-        currency (str): The currency type of the account.
-
-    Returns:
-        int or None: Returns the account ID if the account exists, otherwise returns None.
-
-    Example:
-        account_id = check_account_exists(1, "3434 3434 5667 2223", "USD")
-    """
+def check_account_exists_by_uid_cardnumber_currency(uid, card_number, currency):
     try:
         account = db.session.query(CurrentAccount).filter_by(card_number=card_number, uid=uid, currency=currency).first()
         return account.account_id if account else None
     except Exception as e:
         return None
 
 # Method to check if an account exists based on UID and currency
-def get_account_number(uid, card_number):
+def get_account_number_by_uid_and_cardnumber(uid, card_number):
     try:
         account = db.session.query(CurrentAccount).filter_by(card_number=card_number, uid=uid).first()
         return account
     except Exception as e:
         return None
 
 def get_current_account_by_id(account_id):
-    """
-    Checks if a current account exists based on the account ID.
-
-    Args:
-        account_id (int): The account ID to check.
-
-    Returns:
-        bool: Returns an account if the account exists, otherwise returns None.
-
-    Example:
-        account_exists = check_current_account_exists(123)
-    """
     try:
         # Query the database to find the account with the given account ID
         account = db.session.query(CurrentAccount).filter_by(account_id=account_id).first()
@@ -89,19 +45,6 @@ def get_current_account_by_id(account_id):
 
 # Method to update the balance of an account by account ID
 def update_account_balance(account_id, amount):
-    """
-    Updates the balance of an account by account ID.
-
-    Args:
-        account_id (int): The unique identifier for the account.
-        amount (float): The new amout to be added in the account.
-
-    Returns:
-        bool: True if the account balance is successfully updated, otherwise False.
-
-    Example:
-        success = update_account_balance(1, 1500.00)
-    """
     try:
         account = db.session.query(CurrentAccount).get(account_id)
         if account:
@@ -115,7 +58,7 @@ def update_account_balance(account_id, amount):
         return False
 
 # Method to get account by account number
-def get_account_by_number(account_number):
+def get_account_by_account_number(account_number):
     try:
         account = db.session.query(CurrentAccount).filter_by(account_number=str(account_number).strip()).first()
         return account
@@ -131,26 +74,10 @@ def get_account_by_number_and_currency(account_number, currency):
         return None
 
 # Method to get all current accounts connected with credit card
-def get_all_current_accounts(card_number):
-    """
-    Retrieves all accounts associated with a specified credit card number.
-
-    Args:
-        card_number (str): The credit card number to search for.
-
-    Returns:
-        list or None: A list of CurrentAccount objects associated with the specified card_number.
-                      Returns None if an error occurs during the query.
-
-    Example:
-        accounts = get_all_current_accounts('1234567890123456')
-        if accounts:
-            for account in accounts:
-                print(f"Account ID: {account.account_id}, Balance: {account.balance}, Currency: {account.currency}")
-    """
+def get_all_current_accounts_by_cardnumber(card_number):
     try:
         accounts = db.session.query(CurrentAccount).filter(CurrentAccount.card_number == card_number).all()
-        return accounts
+        return [account.serialize() for account in accounts]
     except Exception as e:
         return None
 
@@ -164,7 +91,7 @@ def exchange_funds(account_id, new_balance, amount_to_exchange, currency_to_conv
         if float(account.balance) < float(amount_to_exchange) or float(amount_to_exchange) < 0.0:
             response['error'] = "Insufficient funds on the account"; response['code'] = 400
         else:
-            account_id_destination = check_account_exists(account.uid, account.card_number, currency_to_convert)
+            account_id_destination = check_account_exists_by_uid_cardnumber_currency(account.uid, account.card_number, currency_to_convert)
 
             # If current account already has account with convert currency then just update it
             if account_id_destination: