compose an email with an invoice on macOS

Author: clstaudt

Diff for: app/components/view_user.py

@@ -32,7 +32,8 @@ def demo_user():
         phone_number="+55555555555",
         VAT_number="27B-6",
         address=Address(
-            name="Harry Tuttle",
+            first_name="Harry",
+            last_name="Tuttle",
             street="Main Street",
             number="450",
             city="Sao Paolo",

Diff for: app/views.py

@@ -401,17 +401,24 @@ def make_invoice_view(
                         trailing=PopupMenuButton(
                             icon=icons.MORE_VERT,
                             items=[
+                                # PopupMenuItem(
+                                #     icon=icons.VISIBILITY,
+                                #     text="View",
+                                #     on_click=lambda _: app_page.app.con.quicklook_invoice(
+                                #         invoice
+                                #     ),
+                                # ),
                                 PopupMenuItem(
-                                    icon=icons.VISIBILITY,
-                                    text="View",
-                                    on_click=lambda _: app_page.app.con.quicklook_invoice(
+                                    icon=icons.PREVIEW,
+                                    text="Open",
+                                    on_click=lambda _: app_page.app.con.open_invoice(
                                         invoice
                                     ),
                                 ),
                                 PopupMenuItem(
-                                    icon=icons.PREVIEW,
-                                    text="Open",
-                                    on_click=lambda _: app_page.app.con.open_invoice(
+                                    icon=icons.OUTGOING_MAIL,
+                                    text="Send",
+                                    on_click=lambda _: app_page.app.con.send_invoice(
                                         invoice
                                     ),
                                 ),

Diff for: notebooks/test-compose-email.ipynb

@@ -0,0 +1,69 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from tuttle import os_functions"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "message_attachment = 0\n"
+     ]
+    }
+   ],
+   "source": [
+    "os_functions.compose_email_in_app(\n",
+    "    recipient=\"[email protected]\",\n",
+    "    subject=\"Test\",\n",
+    "    body=\"Test\",\n",
+    "    attachment_path=\"/Users/cls/Stack/monalisa.jpeg\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.10.5 ('tuttle-flet')",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.5"
+  },
+  "orig_nbformat": 4,
+  "vscode": {
+   "interpreter": {
+    "hash": "5727a89f8f4826e6ce3fb9da18a08727b274ba76880924157270e222bba4a1ac"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

Diff for: tuttle/__init__.py

@@ -17,6 +17,7 @@
     time,
     rendering,
     view,
+    os_functions,
 )
 
 

Diff for: tuttle/controller.py

@@ -13,8 +13,23 @@
 
 from loguru import logger
 
-from . import model, timetracking, dataviz, rendering, invoicing, calendar, cloud
+from . import (
+    model,
+    timetracking,
+    dataviz,
+    rendering,
+    invoicing,
+    calendar,
+    cloud,
+    os_functions,
+)
 from .preferences import Preferences
+from .model import (
+    User,
+    Project,
+    Contract,
+    Invoice,
+)
 
 
 class Controller:
@@ -296,13 +311,16 @@ def billing(
             # finally store invoice
             self.store(invoice)
 
-    def open_invoice(self, invoice):
+    def open_invoice(
+        self,
+        invoice: Invoice,
+    ):
         """Open an invoice in the default application for PDF files"""
         invoice_file_path = (
             self.home
             / self.preferences.invoice_dir
             / Path(invoice.prefix)
-            / Path(f"{invoice.prefix}.pdf")
+            / Path(invoice.file_name)
         )
         if invoice_file_path.exists():
             if platform.system() == "Darwin":  # macOS
@@ -315,13 +333,16 @@ def open_invoice(self, invoice):
         else:
             logger.error(f"invoice file {invoice_file_path} not found")
 
-    def quicklook_invoice(self, invoice):
+    def quicklook_invoice(
+        self,
+        invoice: Invoice,
+    ):
         """Open an invoice in the preview application for PDF files"""
         invoice_file_path = (
             self.home
             / self.preferences.invoice_dir
             / Path(invoice.prefix)
-            / Path(f"{invoice.prefix}.pdf")
+            / Path(invoice.file_name)
         )
         if invoice_file_path.exists():
             if platform.system() == "Darwin":  # macOS
@@ -330,3 +351,28 @@ def quicklook_invoice(self, invoice):
                 logger.error(f"quicklook not supported on {platform.system()}")
         else:
             logger.error(f"invoice file {invoice_file_path} not found")
+
+    def send_invoice(self, invoice: Invoice):
+        """Compose an email to the client with the invoice attached"""
+        invoice_file_path = (
+            self.home
+            / self.preferences.invoice_dir
+            / Path(invoice.prefix)
+            / Path(invoice.file_name)
+        )
+        if invoice_file_path.exists():
+            if platform.system() == "Darwin":
+                email = invoicing.generate_invoice_email(
+                    invoice,
+                    self.user,
+                )
+                os_functions.compose_email(
+                    recipient=email["recipient"],
+                    subject=email["subject"],
+                    body=email["body"],
+                    attachment_path=invoice_file_path,
+                )
+            else:
+                logger.error(f"emailing not yet supported on {platform.system()}")
+        else:
+            logger.error(f"invoice file {invoice_file_path} not found")

Diff for: tuttle/invoicing.py

@@ -1,6 +1,6 @@
 """Invoicing."""
 
-from typing import List
+from typing import List, Optional, Dict
 import datetime
 from pathlib import Path
 import shutil
@@ -53,3 +53,25 @@ def send_invoice(
         body=None,  #
         attachments=None,  # TODO: inovice as PDF
     )
+
+
+def generate_invoice_email(
+    invoice: Invoice,
+    user: User,
+) -> Dict:
+    """Generate an email with the invoice attached."""
+    body = f"""
+    Dear {invoice.client.invoicing_contact.first_name}
+
+    Please find attached the invoice number {invoice.number}.
+
+    Best regards
+    {user.name}
+    """
+
+    email = {
+        "subject": f"Invoice {invoice.number}",
+        "body": body,
+        "recipient": invoice.client.invoicing_contact.email,
+    }
+    return email

Diff for: tuttle/model.py

@@ -155,7 +155,8 @@ class Contact(SQLModel, table=True):
     """An entry in the address book."""
 
     id: Optional[int] = Field(default=None, primary_key=True)
-    name: str
+    first_name: str
+    last_name: str
     company: Optional[str]
     email: Optional[str]
     address_id: Optional[int] = Field(default=None, foreign_key="address.id")
@@ -383,6 +384,11 @@ def prefix(self):
         prefix = f"{self.number}-{client_suffix}"
         return prefix
 
+    @property
+    def file_name(self):
+        """A string that can be used as a file name."""
+        return f"{self.prefix}.pdf"
+
 
 class InvoiceItem(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)

Diff for: tuttle/os_functions.py

@@ -0,0 +1,64 @@
+"""OS-level function"""
+from typing import Optional
+import subprocess
+import platform
+from pathlib import Path
+
+
+def open_application(app_name):
+    """Open an application by name."""
+    if platform.system() == "Darwin":
+        subprocess.call(["open", "-a", app_name])
+    elif platform.system() == "Windows":
+        subprocess.call(["start", app_name], shell=True)
+    elif platform.system() == "Linux":
+        subprocess.call(["xdg-open", app_name])
+
+
+def run_applescript(script):
+    """Run an AppleScript."""
+    subprocess.call(["osascript", "-e", script])
+
+
+def compose_email(
+    recipient: str,
+    subject: str,
+    body: str,
+    attachment_path: Optional[Path],
+):
+    """Compose an email in the default email application."""
+    if platform.system() == "Darwin":
+        script_set_attachment = f"""
+        set theAttachmentPath to "{attachment_path}"
+        set theAttachmentFile to (theAttachmentPath as POSIX file)
+        """
+
+        script_set_vars = f"""
+        set theSubject to "{subject}"
+        set theBody to "{body}"
+        set theAddress to "{recipient}"
+        """
+
+        script_compose_email = """
+        tell application "Mail" to activate
+        tell application "Mail"
+            set theNewMessage to make new outgoing message with properties {subject:theSubject, content:theBody & return & return, visible:true}
+            tell theNewMessage
+                set visibile to true
+                #set sender to theSender
+                make new recipient at end of to recipients with properties {address:theAddress}
+                try
+                    make new attachment with properties {file name:theAttachmentFile} at after the last word of the last paragraph
+                    set message_attachment to 0
+                on error errmess -- oops
+                    log errmess -- log the error
+                    set message_attachment to 1
+                end try
+            end tell
+        end tell
+        """
+
+        script = script_set_attachment + script_set_vars + script_compose_email
+        run_applescript(script)
+    else:
+        raise ValueError("Unsupported OS")

Diff for: tuttle_tests/conftest.py

@@ -11,7 +11,8 @@
 @pytest.fixture
 def demo_contact():
     return Contact(
-        name="Sam Lowry",
+        fist_name="Sam",
+        last_name="Lowry",
         email="[email protected]",
         address=Address(
             street="Main Street",
@@ -26,7 +27,8 @@ def demo_contact():
 @pytest.fixture
 def demo_user():
     user = User(
-        name="Harry Tuttle",
+        first_name="Harry",
+        last_name="Tuttle",
         subtitle="Heating Engineer",
         website="https://tuttle-dev.github.io/tuttle/",
         email="[email protected]",
@@ -52,9 +54,11 @@ def demo_user():
 @pytest.fixture
 def demo_clients():
     central_services = Client(
-        name="Central Services",
+        first_name="Central",
+        last_name="Services",
         invoicing_contact=Contact(
-            name="Central Services",
+            first_name="Central",
+            last_name="Services",
             email="[email protected]",
             address=Address(
                 street="Main Street",
@@ -69,7 +73,8 @@ def demo_clients():
     sam_lowry = Client(
         name="Sam Lowry",
         invoicing_contact=Contact(
-            name="Sam Lowry",
+            first_name="Sam",
+            last_name="Lowry",
             email="[email protected]",
             address=Address(
                 street="Main Street",