🐛 PrimeLunch Refunds

Author: juftin

docs/source/primelunch.md

@@ -51,13 +51,14 @@ The below command runs the `PrimeLunch` update tool:
 lunchable plugins primelunch run -f ~/Downloads/amazon_order_history.csv
 ```
 
-The below command runs the `PrimeLunch` update tool using a date window of three days
-instead of 5 days:
+The below command runs the `PrimeLunch` update tool using a date window of fourteen days
+instead of the default seven days (these larger windows are especially useful for finding refunds and recurring
+purchases):
 
 ```shell
 lunchable plugins primelunch run \
    --file ~/Downloads/amazon_order_history.csv \
-   --window 3
+   --window 14
 ```
 
 Update all transactions without going through the confirmation prompt for each one:

lunchable/plugins/primelunch/README.md

@@ -51,13 +51,14 @@ The below command runs the `PrimeLunch` update tool:
 lunchable plugins primelunch run -f ~/Downloads/amazon_order_history.csv
 ```
 
-The below command runs the `PrimeLunch` update tool using a date window of three days
-instead of 5 days:
+The below command runs the `PrimeLunch` update tool using a date window of fourteen days
+instead of the default seven days (these larger windows are especially useful for finding refunds and recurring
+purchases):
 
 ```shell
 lunchable plugins primelunch run \
    --file ~/Downloads/amazon_order_history.csv \
-   --window 3
+   --window 14
 ```
 
 Update all transactions without going through the confirmation prompt for each one:

lunchable/plugins/primelunch/primelunch.py

@@ -19,7 +19,7 @@
 
 from lunchable import LunchMoney, TransactionUpdateObject
 from lunchable._config.logging_config import set_up_logging
-from lunchable.models import TransactionObject
+from lunchable.models import CategoriesObject, TransactionObject
 
 logger = logging.getLogger(__name__)
 
@@ -32,7 +32,7 @@ class PrimeLunch:
     def __init__(
         self,
         file_path: str | os.PathLike,
-        time_window: int = 5,
+        time_window: int = 7,
         access_token: Optional[str] = None,
     ) -> None:
         """
@@ -43,6 +43,7 @@ def __init__(
         self.transaction_map: Dict[int, TransactionObject] = {}
         self.cached = False
         self.lunch = LunchMoney(access_token=access_token)
+        self.categories: dict[int, CategoriesObject] = {}
 
     @staticmethod
     def transactions_to_df(transactions: List[TransactionObject]) -> pd.DataFrame:
@@ -169,7 +170,7 @@ def deduplicate_matched(cls, df: pd.DataFrame) -> pd.DataFrame:
 
     @classmethod
     def merge_transactions(
-        cls, amazon: pd.DataFrame, transactions: pd.DataFrame, time_range: int = 5
+        cls, amazon: pd.DataFrame, transactions: pd.DataFrame, time_range: int = 7
     ) -> pd.DataFrame:
         """
         Merge Amazon Transactions and LunchMoney Transaction
@@ -186,16 +187,20 @@ def merge_transactions(
         -------
         pd.DataFrame
         """
+        refunded_data = amazon[amazon["refund"] > 0].copy()
+        refunded_data["total"] = -refunded_data["refund"]
+        refunded_data["items"] = "REFUND: " + refunded_data["items"]
+        complete_amazon_data = pd.concat([amazon, refunded_data], ignore_index=True)
         merged_data = transactions.copy()
         merged_data = merged_data.merge(
-            amazon,
+            complete_amazon_data,
             how="inner",
             left_on=["amount"],
             right_on=["total"],
             suffixes=(None, "_amazon"),
         )
         merged_data["start_date"] = merged_data["date_amazon"]
-        merged_data["end_date"] = merged_data["start_date"] + datetime.timedelta(
+        merged_data["end_date"] = merged_data["date_amazon"] + datetime.timedelta(
             days=time_range
         )
         merged_data.query(
@@ -232,14 +237,14 @@ def cache_transactions(
             start_date=start_date, end_date=end_cache_date
         )
         transaction_map = {item.id: item for item in transactions}
+        self.categories = {item.id: item for item in self.lunch.get_categories()}
         self.transaction_map = transaction_map
         self.cached = True
         logger.info("%s transactions returned from LunchMoney", len(transactions))
         return transaction_map
 
-    @classmethod
     def print_transaction(
-        cls, transaction: TransactionObject, former_transaction: TransactionObject
+        self, transaction: TransactionObject, former_transaction: TransactionObject
     ) -> None:
         """
         Print a Transaction for interactive input
@@ -250,8 +255,12 @@ def print_transaction(
         transaction_table.add_row("🏦 Payee", former_transaction.payee)
         transaction_table.add_row("📅 Date", str(former_transaction.date))
         transaction_table.add_row(
-            "💰 Amount", "$" + str(round(former_transaction.amount, 2))
+            "💰 Amount", self.format_currency(amount=former_transaction.amount)
         )
+        if former_transaction.category_id is not None:
+            transaction_table.add_row(
+                "📊 Category", self.categories[former_transaction.category_id].name
+            )
         if (
             former_transaction.original_name is not None
             and former_transaction.original_name != former_transaction.payee
@@ -329,7 +338,9 @@ def process_transactions(self, confirm: bool = True):
         )
         amazon_transaction_df = self.filter_amazon_transactions(df=transaction_df)
         merged_data = self.merge_transactions(
-            transactions=amazon_transaction_df, amazon=amazon_df, time_range=5
+            transactions=amazon_transaction_df,
+            amazon=amazon_df,
+            time_range=self.time_window,
         )
         updated_transactions = self.df_to_transactions(df=merged_data)
         responses = []
@@ -339,6 +350,26 @@ def process_transactions(self, confirm: bool = True):
                 responses.append(resp)
         logger.info("%s LunchMoney transactions updated", len(responses))
 
+    @staticmethod
+    def format_currency(amount: float) -> str:
+        """
+        Format currency amounts to be pleasant and human readable
+
+        Parameters
+        ----------
+        amount: float
+            Float Amount to be converted into a string
+
+        Returns
+        -------
+        str
+        """
+        if amount < 0:
+            float_string = "[bold red]$ ({:,.2f})[/bold red]".format(float(abs(amount)))
+        else:
+            float_string = "[bold green]$ {:,.2f}[/bold green]".format(float(amount))
+        return float_string
+
 
 @click.command("run")
 @click.option(
@@ -356,7 +387,7 @@ def process_transactions(self, confirm: bool = True):
     type=click.INT,
     help="Allowable time window between Amazon transaction date and "
     "credit card transaction date",
-    default=5,
+    default=7,
 )
 @click.option(
     "-a",