Update package structure

webqueue2_api/ECNQueue/Item.py

@@ -0,0 +1,72 @@
+from . import queue_directory, queues_to_ignore
+from .parser import parser
+import os
+queueDirectory = queue_directory
+
+class Item:
+    """A chronological representation of an interaction with a user.
+    Example:
+            # Create an Item (ce100)
+            >>> item = Item("ce", 100, headersOnly=false)
+            # Create an Item without parsing its contents (ce100)
+            >>> item = Item("ce", 100, headersOnly=True)
+    Args:
+            queue (str): The name of the Item's queue.
+            number (int): The number of the Item.
+            headersOnly (bool, optional): Whether or not to parse headers only. Defaults to True.
+    Attributes:
+            lastUpdated: An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem.
+            headers: A list of dictionaries containing header keys and values.
+            content: A list of section dictionaries (only included if headersOnly is False).
+            isLocked: A boolean showing whether or not a lockfile for the item is present.
+            userEmail: The email address of the person who this item is from.
+            userName: The real name of the person who this item is from.
+            userAlias: The Purdue career account alias of the person this item is from.
+            assignedTo: The Purdue career account alias of the person this item is assigned to
+            subject: The subject of the original message for this item.
+            status: The most recent status update for the item.
+            priority: The most recent priority for this item.
+            department: The most recent department for this item.
+            dateReceived: The date this item was created.
+            jsonData: A JSON serializable representation of the Item.
+    Raises:
+            ValueError: When the number passed to the constructor cannot be parsed.
+    """
+
+    def __init__(self, queue: str, number: int, headersOnly: bool = False) -> None:
+        self.queue = queue
+        try:
+            self.number = int(number)
+        except ValueError:
+            raise ValueError(f'Could not convert "{number}" to an integer')
+        self.__path = "/".join([queueDirectory, self.queue, str(self.number)])
+        self.lastUpdated = parser.getLastUpdated(self.__path)
+        self.__rawItem = parser.getRawItem(self.__path)
+        self.headers = parser.parseHeaders(self.__rawItem)
+        if not headersOnly: self.content = parser.parseSections(self.headers, self.__rawItem, self.__path)
+        self.isLocked = parser.isLocked(self.__path, self.queue, self.number)
+        self.userEmail = parser.parseFromData(self.headers, data="userEmail")
+        self.userName = parser.parseFromData(self.headers, data="userName")
+        self.userAlias = parser.getUserAlias(self.headers, self.userEmail)
+        self.assignedTo = parser.getMostRecentHeaderByType(self.headers, "Assigned-To")
+        self.subject = parser.getMostRecentHeaderByType(self.headers, "Subject")
+        self.status = parser.getMostRecentHeaderByType(self.headers, "Status")
+        self.priority = parser.getMostRecentHeaderByType(self.headers, "Priority")
+        self.department = parser.getMostRecentHeaderByType(self.headers, "Department")
+        self.building = parser.getMostRecentHeaderByType(self.headers, "Building")
+        self.dateReceived = parser.getFormattedDate(parser.getMostRecentHeaderByType(self.headers, "Date"))
+        self.jsonData = {}
+
+        for attribute in self.__dir__():
+            if "_" not in attribute and attribute != "toJson" and attribute != "jsonData":
+                self.jsonData[attribute] = self.__getattribute__(attribute)
+
+    def toJson(self) -> dict:
+        """Returns a JSON safe representation of the item.
+        Returns:
+                dict: JSON safe representation of the item.
+        """
+        return self.jsonData
+
+    def __repr__(self) -> str:
+        return self.queue + str(self.number)

webqueue2_api/ECNQueue/Queue.py

@@ -0,0 +1,61 @@
+from . import utils, Item
+from .parser import parser
+from . import queue_directory
+from os import listdir, path
+
+queueDirectory = queue_directory
+
+class Queue:
+    """A collection of Items.
+    Example:
+            # Create a queue (ce)
+            >>> queue = Queue("ce")
+            # Create a queue without parsing item contents (ce)
+            >>> queue = Queue("ce", headersOnly=False)
+    Args:
+            queue (str): The name of the queue.
+            headersOnly (bool, optional): Whether or not to parse headers only. Defaults to True.
+    Attributes:
+            name: The name of the queue.
+            items: A list of Items in the queue.
+            jsonData: A JSON serializable representation of the Queue.
+    """
+
+    def __init__(self, name: str, headersOnly: bool = True) -> None:
+        self.name = name
+        self.headersOnly = headersOnly
+        self.__directory = queueDirectory + "/" + self.name + "/"
+        self.items = parser.getItems(self.name, self.headersOnly)
+        self._index = 0
+
+        self.jsonData = {
+            "name": self.name,
+            "length": len(self)
+        }
+
+    def toJson(self) -> dict:
+        """Return JSON safe representation of the Queue
+        The JSON representation of every item in the Queue is added to the
+        Queue's JSON data then the Queue's JSON data is returned.
+        Returns:
+                dict: JSON safe representation of the Queue
+        """
+        items = []
+        for item in self.items:
+            items.append(item.toJson())
+        self.jsonData["items"] = items
+
+        return self.jsonData
+
+    def __len__(self) -> int:
+        return len(self.items)
+
+    def __repr__(self) -> str:
+        return f'{self.name}_queue'
+
+    # Implements the interable interface requirements by passing direct references 
+    # to the item list's interable values.
+    def __iter__(self) -> list:
+        return iter(self.items)
+    def __next__(self) -> int:
+        return iter(self.items).__next__()

webqueue2_api/ECNQueue/__init__.py

@@ -0,0 +1,18 @@
+import configparser
+from ..logger import logger
+from .. import global_configs
+
+queue_directory = "/home/pier/e/queue/Mail"
+queues_to_ignore = ["archives", "drafts", "inbox", "coral"]
+
+logger.name = __name__
+
+def applyQueueDirectory(dir: str) -> None:
+    global queue_directory
+    queue_directory = dir
+    return
+
+def applyQueuesToIgnore(ignore: list) -> None:
+    global queues_to_ignore
+    queues_to_ignore = ignore
+    return

webqueue2_api/ECNQueue/parser/__init__.py

@@ -0,0 +1 @@
+from . import parser