camisatoshi-wordpress-reports/camisatoshi_wordpress_reports/controllers.py

174 lines
5.3 KiB
Python
Raw Normal View History

from pathlib import Path
2023-08-03 09:29:11 +02:00
import datetime
2023-08-03 09:42:22 +02:00
import logging
2023-08-03 18:13:51 +02:00
import csv
from dotenv import dotenv_values
from woocommerce import API
2023-08-03 16:50:40 +02:00
from camisatoshi_wordpress_reports.order import Order, Orders
2023-08-03 23:29:22 +02:00
from camisatoshi_wordpress_reports.constants import (
um_first_agreement_percentage,
)
API_CONFIG = dotenv_values(
dotenv_path=Path.home() / Path(".camisatoshi-wordpress-reports/.env")
)
2023-08-02 20:09:28 +02:00
WC_API = API(
url=API_CONFIG["URL"],
consumer_key=API_CONFIG["CONSUMER_KEY"],
consumer_secret=API_CONFIG["CONSUMER_SECRET"],
version=API_CONFIG["VERSION"],
)
2023-08-02 19:56:59 +02:00
2023-08-03 09:42:22 +02:00
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger()
2023-08-02 19:56:59 +02:00
2023-08-02 19:49:36 +02:00
def check_health():
2023-08-03 23:29:22 +02:00
logger.info(
f"Connecting to the configured WooCommerce at {API_CONFIG['URL']}"
)
2023-08-02 19:56:59 +02:00
try:
2023-08-02 20:09:28 +02:00
api_reported_version = WC_API.get("").json()["namespace"]
2023-08-02 19:56:59 +02:00
except:
2023-08-03 23:29:22 +02:00
raise ConnectionError(
"There was an issue connecting to the WooCommerce API."
)
2023-08-02 19:56:59 +02:00
2023-08-03 09:42:22 +02:00
logger.info(f"Informed version of the API: {API_CONFIG['VERSION']}")
logger.info(f"Version reported by the API itself: {api_reported_version}")
2023-08-02 19:56:59 +02:00
2023-08-03 09:42:22 +02:00
logger.info("Connection successful. The API is reachable.")
2023-08-02 20:09:28 +02:00
2023-08-03 16:50:40 +02:00
def generate_um_report(
2023-08-03 22:33:34 +02:00
start_date: datetime.datetime, end_date: datetime.datetime
2023-08-03 16:50:40 +02:00
) -> None:
2023-08-03 09:42:22 +02:00
logger.info(f"Fetching orders between {start_date} and {end_date}.")
2023-08-03 09:29:11 +02:00
orders_in_date_range = WC_API.get(
endpoint="orders",
params={
"after": start_date.isoformat(),
"before": end_date.isoformat(),
2023-08-03 09:29:11 +02:00
"per_page": 100,
"status": "processing,completed",
},
2023-08-03 09:42:22 +02:00
).json()
2023-08-03 16:50:40 +02:00
orders_in_date_range = Orders(
[
Order.from_api_response(order_raw_data)
for order_raw_data in orders_in_date_range
]
)
2023-08-03 09:42:22 +02:00
logger.info(f"Received {len(orders_in_date_range)} orders.")
2023-08-03 18:13:51 +02:00
relevant_sku = "TEE-05-BBO-BLACK"
logger.info(f"Filtering by SKU: {relevant_sku}")
2023-08-03 23:29:22 +02:00
relevant_orders = orders_in_date_range.filter_orders_by_sku(
sku=relevant_sku
2023-08-03 22:33:34 +02:00
)
logger.info(f"Kept {len(relevant_orders)} orders.")
2023-08-03 23:29:22 +02:00
logger.info(
"Checking if all orders have the sats_received entry filled in."
)
orders_without_sats_received = (
relevant_orders.filter_orders_without_sats_received()
)
2023-08-03 22:33:34 +02:00
if orders_without_sats_received:
logger.warning(
f"There are {len(orders_without_sats_received)} orders without a properly filled sats_received entry."
)
logger.warning(f"See details below.")
logger.warning(orders_without_sats_received)
raise ValueError(
"Not all orders have sats_received. Can't compute sats owed without that."
)
logger.info("Success, all orders have sats_received filled in.")
logger.info("Removing settled orders.")
unsettled_orders = relevant_orders.filter_unsettled_orders()
logger.info(f"Kept {len(unsettled_orders)} unsettled orders.")
2023-08-03 23:29:22 +02:00
logger.info("Order filtering finished.")
2023-08-03 22:33:34 +02:00
2023-08-03 23:29:22 +02:00
logger.info(
f"Relevant orders: {[order['id'] for order in unsettled_orders]}."
)
2023-08-03 22:33:34 +02:00
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)
def generate_sku_report(start_date, end_date, sku):
logger.info(f"Fetching orders between {start_date} and {end_date}.")
orders_in_date_range = WC_API.get(
endpoint="orders",
params={
"after": start_date.isoformat(),
"before": end_date.isoformat(),
"per_page": 100,
"status": "processing,completed",
},
).json()
orders_in_date_range = Orders(
[
Order.from_api_response(order_raw_data)
for order_raw_data in orders_in_date_range
]
)
logger.info(f"Received {len(orders_in_date_range)} orders.")
logger.info(f"Filtering by SKU: {sku}")
relevant_orders = orders_in_date_range.filter_orders_by_sku(sku=sku)
logger.info(f"Kept {len(relevant_orders)} orders.")
logger.info("Order filtering finished.")
2023-08-03 23:29:22 +02:00
logger.info(
2023-09-03 05:16:59 +02:00
f"Relevant orders: {[order['id'] for order in relevant_orders]}."
2023-08-03 23:29:22 +02:00
)
2023-08-03 22:33:34 +02:00
report = []
2023-09-03 05:16:59 +02:00
for order in relevant_orders:
2023-08-03 22:33:34 +02:00
report.append(
{
"order_id": order["id"],
"sku": sku,
"units_sold": order.units_of_sku(sku),
"eur_income": order.sales_of_sku(sku),
}
)
logger.info("Report generated.")
logger.info(report)
keys = report[0].keys()
with open("report.csv", "w", newline="") as output_file:
2023-08-03 18:13:51 +02:00
dict_writer = csv.DictWriter(output_file, keys)
dict_writer.writeheader()
dict_writer.writerows(report)