Report kind of complete

camisatoshi_wordpress_reports/constants.py

@@ -1,12 +1,23 @@
 from types import SimpleNamespace
 
+### Order keys
+
 order_keys = SimpleNamespace()
 order_keys.meta_data = "meta_data"
+order_keys.total = "total"
 order_keys.line_items = "line_items"
 
 order_keys.line_item_keys = SimpleNamespace()
 order_keys.line_item_keys.sku = "sku"
+order_keys.line_item_keys.quantity = "quantity"
+order_keys.line_item_keys.total = "total"
 
 custom_meta_data_keys = SimpleNamespace()
 custom_meta_data_keys.is_settled_with_um = "is_settled_with_um"
-custom_meta_data_keys.sats_received = "sats_received"
+custom_meta_data_keys.sats_received = "sats_received"
+
+
+### Other
+
+um_first_agreement_percentage = 0.5
+bbo_royalty_fee = 0.2

camisatoshi_wordpress_reports/controllers.py

@@ -1,13 +1,13 @@
 from pathlib import Path
 import datetime
-from typing import List, Dict
 import logging
+import csv
 
 from dotenv import dotenv_values
 from woocommerce import API
 
 from camisatoshi_wordpress_reports.order import Order, Orders
-from camisatoshi_wordpress_reports.constants import custom_meta_data_keys
+from camisatoshi_wordpress_reports.constants import um_first_agreement_percentage
 
 API_CONFIG = dotenv_values(
     dotenv_path=Path.home() / Path(".camisatoshi-wordpress-reports/.env")
@@ -38,7 +38,7 @@ def check_health():
 
 
 def generate_um_report(
-    start_date: datetime.datetime, end_date: datetime.datetime
+        start_date: datetime.datetime, end_date: datetime.datetime
 ) -> None:
     logger.info(f"Fetching orders between {start_date} and {end_date}.")
 
@@ -59,9 +59,9 @@ def generate_um_report(
     )
     logger.info(f"Received {len(orders_in_date_range)} orders.")
 
-    skus_to_keep = ["TEE-05-BBO-BLACK"]
-    logger.info(f"Filtering by SKUs: {skus_to_keep}")
-    relevant_orders = orders_in_date_range.filter_orders_by_skus(skus=skus_to_keep)
+    relevant_sku = "TEE-05-BBO-BLACK"
+    logger.info(f"Filtering by SKU: {relevant_sku}")
+    relevant_orders = orders_in_date_range.filter_orders_by_sku(sku=relevant_sku)
     logger.info(f"Kept {len(relevant_orders)} orders.")
 
     logger.info("Checking if all orders have the sats_received entry filled in.")
@@ -84,15 +84,29 @@ def generate_um_report(
     #   - Between specific dates
     #   - That contain the hardcoded products
     #   - That have been paid, hence status is either processing or completed
-    #   - That have not been settled yet (is_settled_with_um: 0)
+    #   - That have not been settled yet (is_settled_with_um = 0)
+    logger.info("Order filtering finished.")
 
-    # Print to screen:
-    #   - Orders that do not have the `sats_received` metadata informed
-    #   - The unit count for each product
-    #   - The sales sum for each product
-    #   - The sats sum for each product
-    #   - The corresponding payment owed to UM
-    #   - The list of order ids that have been taken into account
+    logger.info(f"Relevant orders: {[order['id'] for order in unsettled_orders]}.")
 
-    # Update orders:
-    #   - Add metadata entry: is_settled_with_um: 1
+    report = []
+    for order in unsettled_orders:
+        report.append(
+            {
+                "order_id": order["id"],
+                "sku": relevant_sku,
+                "units_sold": order.units_of_sku(relevant_sku),
+                "eur_income": order.sales_of_sku(relevant_sku),
+                "sats_income": order.sats_received_for_sku(relevant_sku),
+                "sats_owed_to_um": order.sats_received_for_sku(relevant_sku) * um_first_agreement_percentage,
+            }
+        )
+    logger.info("Report generated.")
+    logger.info(report)
+
+    keys = report[0].keys()
+
+    with open('report.csv', 'w', newline='') as output_file:
+        dict_writer = csv.DictWriter(output_file, keys)
+        dict_writer.writeheader()
+        dict_writer.writerows(report)

camisatoshi_wordpress_reports/order.py

@@ -1,6 +1,7 @@
-from typing import List, Dict, Collection
+from typing import Dict, Collection
 
 from camisatoshi_wordpress_reports.constants import order_keys, custom_meta_data_keys
+from camisatoshi_wordpress_reports.utils import safe_zero_division
 
 
 class Order:
@@ -17,6 +18,34 @@ class Order:
             for meta_data_entry in self.raw_data[order_keys.meta_data]
         }
 
+    def units_of_sku(self, sku: str) -> int:
+        units = 0
+        for line in self[order_keys.line_items]:
+            if line[order_keys.line_item_keys.sku] == sku:
+                units += line[order_keys.line_item_keys.quantity]
+        return units
+
+    def sales_of_sku(self, sku: str) -> float:
+        sales = 0
+        for line in self[order_keys.line_items]:
+            if line[order_keys.line_item_keys.sku] == sku:
+                sales += float(line[order_keys.line_item_keys.total])
+        return sales
+
+    def sats_received_for_sku(self, sku: str) -> float:
+        total_order_eur = float(self[order_keys.total])
+        eur_of_sku = self.sales_of_sku(sku)
+
+        monetary_weight_of_sku_in_order = safe_zero_division(eur_of_sku, total_order_eur)
+        total_order_sats_received = float(
+            self.meta_data_entries[custom_meta_data_keys.sats_received]
+        )
+        sats_received_for_sku = (
+            monetary_weight_of_sku_in_order * total_order_sats_received
+        )
+
+        return sats_received_for_sku
+
     def contains_sku(self, sku: str) -> bool:
         for item in self[order_keys.line_items]:
             if item[order_keys.line_item_keys.sku] == sku:
@@ -58,14 +87,12 @@ class Orders:
             return next_order
         raise StopIteration
 
-
-    def filter_orders_by_skus(self, skus: List[str]) -> "Orders":
+    def filter_orders_by_sku(self, sku: str) -> "Orders":
         filtered_orders = []
 
         for order in self:
-            for sku in skus:
-                if order.contains_sku(sku):
-                    filtered_orders.append(order)
+            if order.contains_sku(sku):
+                filtered_orders.append(order)
 
         return Orders(filtered_orders)
 

camisatoshi_wordpress_reports/utils.py

@@ -0,0 +1,2 @@
+def safe_zero_division(n, d):
+    return n / d if d else 0