Final?

Author: charlie-de-muis

CargoHub/CARGOHUB/settings.py

@@ -133,7 +133,7 @@
     'SECURITY_DEFINITIONS': {
         'apiKeyAuth': {
             'type': 'apiKey',
-            'name': 'API_KEY_ADMIN',  # The header name where the token is passed
+            'name': 'APIKEYADMIN',  # The header name where the token is passed
             'in': 'header'           # Indicates the token is passed in the request header
         }
     },

CargoHub/PUML/database_diagram.puml

@@ -1,6 +1,6 @@
 @startuml Database_diagram CargoHub
 
-map Clients_table #Chartreuse {
+map Clients_table #Plum {
     id => INTEGER
     name => TEXT
     address => TEXT
@@ -15,26 +15,158 @@ map Clients_table #Chartreuse {
     updated_at => TEXT
 }
 
-object Inventories_table
+map Inventories_table #Pink {
+    id => INTEGER
+    item_id => INTEGER
+    description => TEXT
+    item_reference => TEXT
+    loactions => TEXT
+    total_on_hand => INTEGER
+    total_expected => INTEGER
+    total_ordered => INTEGER
+    total_allocated => INTEGER
+    total_available => INTEGER
+    created_at => TEXT
+    updated_at => TEXT
+}
 
-object Item_groups_table
+map Item_groups_table #Khaki {
+    id => INTEGER
+    name => TEXT
+    description => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+}
 
-object Item_lines_table
+map Item_lines_table #PHYSICAL {
+    id => INTEGER
+    name => TEXT
+    description => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+}
 
-object Item_types_table
+map Item_types_table #MistyRose {
+    id => INTEGER
+    name => TEXT
+    description => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+}
 
-object Items_table
+map Items_table #BUSINESS {
+    uid => TEXT
+    code => TEXT
+    description => TEXT
+    short_description => TEXT
+    upc_code => TEXT
+    model_number => TEXT
+    commodity_number => TEXT
+    item_line => INTEGER
+    item_group => INTEGER
+    item_type => INTEGER
+    unit_purchase_quantity => INTEGER
+    unt_order_quantity => INTEGER
+    pack_order_quantity => INTEGER
+    supplier_id => INTEGER
+    supplier_code => TEXT
+    supplier_part_number => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+}
 
-object Locations_table
+map Locations_table #Cornsilk {
+    id => INTEGER
+    warehouse_id => INTEGER
+    code => TEXT
+    name => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+}
 
-object Orders_table
+map Orders_table #IMPLEMENTATION {
+    id => INTEGER
+    order_date => TEXT
+    request_date => TEXT
+    reference => TEXT
+    reference_extra => TEXT
+    order_status => TEXT
+    notes => TEXT
+    shipping_notes => TEXT
+    picking_notes => TEXT
+    warehouse_id => INTEGER
+    ship_to => TEXT
+    bill_to => TEXT
+    shipment_id => INTEGER
+    total_amount => INTEGER
+    total_tax => INTEGER
+    total_surcharge => INTEGER
+    created_at => TEXT
+    updated_at => TEXT
+    items => TEXT
+}
 
-object Shipments_table
+map Shipments_table #PeachPuff {
+    id => INTEGER
+    source_id => INTEGER
+    order_date => TEXT
+    request_date => TEXT
+    shipment_date => TEXT
+    shipment_type => TEXT
+    shipment_status => TEXT
+    notes => TEXT
+    carrier_code => TEXT
+    carrier_description => TEXT
+    service_code => TEXT
+    payment_type => TEXT
+    transfer_mode => TEXT
+    total_package_count => INTEGER
+    total_package_weight => INTEGER
+    created_at => TEXT
+    updated_at => TEXT
+    items => TEXT
+}
 
-object Suppliers_table
+map Suppliers_table #TECHNOLOGY {
+    id => INTEGER
+    code => TEXT
+    name => TEXT
+    address => TEXT
+    address_extra => TEXT
+    city => TEXT
+    zip_code => TEXT
+    province => TEXT
+    country => TEXT
+    contact_name => TEXT
+    phonenumber => TEXT
+    reference => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+}
 
-object Transfers_table
+map Transfers_table #SkyBlue {
+    id => INTEGER
+    reference => TEXT
+    transfer_from => TEXT
+    transfer_to => INTEGER
+    transfer_status => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+    items => TEXT
+}
 
-object Warehouses_table
+map Warehouses_table #Lavender {
+    id => INTEGER
+    code => TEXT
+    name => TEXT
+    address => TEXT
+    zip => TEXT
+    city => TEXT
+    province => TEXT
+    country => TEXT
+    contact => TEXT
+    created_at => TEXT
+    updated_at => TEXT
+}
 
 @enduml

CargoHub/api/models/Database_file.py

@@ -9,7 +9,7 @@ def create_database(self):
             conn = sqlite3.connect(database_name)
             cursor = conn.cursor()
 
-            # Define the table creation SQL statements
+            # Define the table creation 
             create_table_clients = """
             CREATE TABLE IF NOT EXISTS clients (
                 id INTEGER PRIMARY KEY,

CargoHub/api/models/clients.py

@@ -166,7 +166,7 @@ def update(self, client_id, client):
                 client['contact_phone'],
                 client['contact_email'],
                 client['created_at'],
-                self.get_timestamp(),  # Assuming this method returns the current timestamp
+                self.get_timestamp(),  
                 client_id
             ))
 

CargoHub/api/models/inventories.py

@@ -38,7 +38,6 @@ def get(self, inventory_id):
         cursor = conn.cursor()
 
         try:
-            # Use the correct placeholder "?" for SQLite
             query = "SELECT * FROM inventories WHERE id = ?"
             cursor.execute(query, (inventory_id,))  # Pass the client_id as a tuple
             inv = cursor.fetchone()  # Fetch a single row
@@ -57,79 +56,77 @@ def get(self, inventory_id):
             cursor.close()
             conn.close()
 
-    # def get_inventories_for_item(self, item_id):
-    #     conn = self.db.connection(self.dbfile)
-    #     if conn is None:
-    #         print("DB connection failed")
-    #         return None  # Exit if connection fails
+    def get_inventories_for_item(self, item_id):
+        conn = self.db.connection(self.dbfile)
+        if conn is None:
+            print("DB connection failed")
+            return None  # Exit if connection fails
 
-    #     try:
-    #         cursor = conn.cursor()
+        try:
+            cursor = conn.cursor()
 
-    #         # Parameterized query to prevent SQL injection
-    #         query = "SELECT * FROM inventories WHERE item_id = ?"
-    #         cursor.execute(query, (item_id,))
+            query = "SELECT * FROM inventories WHERE item_id = ?"
+            cursor.execute(query, (item_id,))
 
-    #         inventories = cursor.fetchall()  # Fetch all records matching the item_id
+            inventories = cursor.fetchall()  # Fetch all records matching the item_id
 
-    #         if not inventories:
-    #             print(f"No inventories found for item ID {item_id}")
-    #             return []  # Return empty list if no records are found
+            if not inventories:
+                print(f"No inventories found for item ID {item_id}")
+                return []  # Return empty list if no records are found
 
-    #         return inventories  # Return the list of inventory records
+            return inventories  # Return the list of inventory records
 
-    #     except Exception as e:
-    #         print(f"An error occurred: {e}")
-    #         return None
-    #     finally:
-    #         cursor.close()
-    #         conn.close()
-
-    # def get_inventory_totals_for_item(self, item_id):
-        # result = {
-        #     "total_expected": 0,
-        #     "total_ordered": 0,
-        #     "total_allocated": 0,
-        #     "total_available": 0
-        # }
-
-        # conn = self.db.connection(self.dbfile)
-        # if conn is None:
-        #     print("DB connection failed")
-        #     return None  # Exit if connection fails
+        except Exception as e:
+            print(f"An error occurred: {e}")
+            return None
+        finally:
+            cursor.close()
+            conn.close()
+
+    def get_inventory_totals_for_item(self, item_id):
+        result = {
+            "total_expected": 0,
+            "total_ordered": 0,
+            "total_allocated": 0,
+            "total_available": 0
+        }
+
+        conn = self.db.connection(self.dbfile)
+        if conn is None:
+            print("DB connection failed")
+            return None  # Exit if connection fails
 
-        # try:
-        #     cursor = conn.cursor()
-
-        #     # Parameterized query to get totals for each column
-        #     query = """
-        #         SELECT total_expected, total_ordered, total_allocated, total_available
-        #         FROM inventories
-        #         WHERE item_id = ?
-        #     """
-        #     cursor.execute(query, (item_id,))
+        try:
+            cursor = conn.cursor()
+
+            query = """
+                SELECT total_expected, total_ordered, total_allocated, total_available
+                FROM inventories
+                WHERE item_id = ?
+            """
+            cursor.execute(query, (item_id,))
 
-        #     inventories = cursor.fetchall()  # Fetch all inventory records
+            inventories = cursor.fetchall()  # Fetch all inventory records
 
-        #     if not inventories:
-        #         print(f"No inventories found for item ID {item_id}")
-        #         return result  # Return default result if no records found
+            if not inventories:
+                print(f"No inventories found for item ID {item_id}")
+                return result  # Return default result if no records found
 
-        #     # Summing up the totals for the given item_id
-        #     for inventory in inventories:
-        #         result["total_expected"] += inventory[0]
-        #         result["total_ordered"] += inventory[1]
-        #         result["total_allocated"] += inventory[2]
-        #         result["total_available"] += inventory[3]
+            # Summing up the totals for the given item_id
+            for inventory in inventories:
+                result["total_expected"] += inventory[0]
+                result["total_ordered"] += inventory[1]
+                result["total_allocated"] += inventory[2]
+                result["total_available"] += inventory[3]
 
-        #     return result  # Return the calculated totals
+            return result  # Return the calculated totals
 
-        # except Exception as e:
-        #     print(f"An error occurred: {e}")
-        #     return None
-        # finally:
-        #     cursor.close()
-        #     conn.close()
+        except Exception as e:
+            print(f"An error occurred: {e}")
+            return None
+        finally:
+            cursor.close()
+            conn.close()
 
     def add(self, inventory):
         conn = self.db.connection(self.dbfile)
@@ -151,7 +148,7 @@ def add(self, inventory):
         ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);"""
 
         location = json.dumps(inventory['locations'])
-        # Preparing the data tuple, including serializing locations as a JSON string
+        # Preparing the data tuple
         data = (
             inventory['id'],
             inventory['item_id'],
@@ -262,12 +259,11 @@ def convert_to_dict(self, inv):
         Converts the inventory tuple fetched from the database into a dictionary
         with the structure of the given JSON. Handles 'locations' properly.
         """
-        locations_str = inv[4]  # The 'locations' field from the database
+        locations_str = inv[4]  
 
         # Check if locations contain square brackets and strip them out
         if locations_str:
-            # Remove square brackets if they exist and then split by commas
-            locations_str = locations_str.strip('[]')  # Strip any square brackets
+            locations_str = locations_str.strip('[]')  
             locations = [int(loc) for loc in locations_str.split(',')] if locations_str else []
         else:
             locations = []

CargoHub/api/models/item_groups.py

@@ -98,7 +98,6 @@ def update(self, item_group_id, item_group):
         try:
             cursor = conn.cursor()
 
-            # Check if the client exists
             cursor.execute("SELECT * FROM item_groups WHERE id = ?", (item_group_id,))
             item_group_old = cursor.fetchone()
             if item_group_old is None:

CargoHub/api/models/item_lines.py

@@ -98,7 +98,6 @@ def update(self, item_line_id, item_line):
         try:
             cursor = conn.cursor()
 
-            # Check if the client exists
             cursor.execute("SELECT * FROM item_lines WHERE id = ?", (item_line_id,))
             item_line_old = cursor.fetchone()
             if item_line_old is None: